louiscklaw/lettersoup-online
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

``add configuration files for CrossNote, VSCode extensions, and documentation for system architecture and design requirements``

Browse Source
This commit is contained in:
louiscklaw
2025-05-14 15:15:45 +08:00
parent 5bebc1f40e
commit d880420a28
9 changed files with 110 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
.crossnote/config.js Normal file
View File

@@ -0,0 +1,15 @@
({
katexConfig: {
"macros": {}
},
mathjaxConfig: {
"tex": {},
"options": {},
"loader": {}
},
mermaidConfig: {
"startOnLoad": false
},
})

19
.crossnote/head.html Normal file
View File

@@ -0,0 +1,19 @@
<!-- The content below will be included at the end of the <head> element. -->
<script type="text/javascript">
const configureMermaidIconPacks = () => {
window['mermaid'].registerIconPacks([
{
name: 'logos',
loader: () => fetch('https://unpkg.com/@iconify-json/logos/icons.json').then((res) => res.json()),
},
]);
};
if (document.readyState !== 'loading') {
configureMermaidIconPacks();
} else {
document.addEventListener('DOMContentLoaded', () => {
configureMermaidIconPacks();
});
}
</script>

12
.crossnote/parser.js Normal file
View File

@@ -0,0 +1,12 @@
({
// Please visit the URL below for more information:
// https://shd101wyy.github.io/markdown-preview-enhanced/#/extend-parser
onWillParseMarkdown: async function(markdown) {
return markdown;
},
onDidParseMarkdown: async function(html) {
return html;
},
})

8
.crossnote/style.less Normal file
View File

@@ -0,0 +1,8 @@
/* Please visit the URL below for more information: */
/* https://shd101wyy.github.io/markdown-preview-enhanced/#/customize-css */
.markdown-preview.markdown-preview {
// modify your style here
// eg: background-color: blue;
}

9
.vscode/extensions.json vendored
View File

@@ -1,12 +1,15 @@
{ {
"recommendations": [ "recommendations": [
"aflalo.dbml-formatter",
"bierner.markdown-mermaid",
"christian-kohler.path-intellisense", "christian-kohler.path-intellisense",
"esbenp.prettier-vscode", "esbenp.prettier-vscode",
"humao.rest-client", "humao.rest-client",
//
"matt-meyers.vscode-dbml", "matt-meyers.vscode-dbml",
"aflalo.dbml-formatter",
"nicolas-liger.dbml-viewer", "nicolas-liger.dbml-viewer",
"yzhang.markdown-all-in-one" //
"bierner.markdown-mermaid",
"yzhang.markdown-all-in-one",
"shd101wyy.markdown-preview-enhanced"
] ]
} }

6
.vscode/settings.json vendored
View File

@@ -15,7 +15,9 @@
"editor.defaultFormatter": "esbenp.prettier-vscode" "editor.defaultFormatter": "esbenp.prettier-vscode"
}, },
"workbench.iconTheme": "material-icon-theme", "workbench.iconTheme": "material-icon-theme",
"workbench.colorTheme": "Default Dark Modern", "workbench.colorTheme": "Mermaid Dark",
"editor.formatOnSave": true, "editor.formatOnSave": true,
"git.ignoreLimitWarning": true "git.ignoreLimitWarning": true,
//
"markdown.styles": ["https://use.fontawesome.com/releases/v5.7.1/css/all.css"]
} }

1
000_AI_WORKSPACE/software-engineer/greetings/002_guideline.md
View File

@@ -28,5 +28,6 @@
- `006_lab` my test (POC) of this project - `006_lab` my test (POC) of this project
- `README.md` Readme of this project - `README.md` Readme of this project
- `TODO.md` todo list of this project - `TODO.md` todo list of this project
- `001_documentation/Requirements/REQ0019/index.md` describes updated system architecture
- if the directory contains `_GUIDELINES.md`, please read it before operation - if the directory contains `_GUIDELINES.md`, please read it before operation

43
001_documentation/Requirements/REQ0019/index.md Normal file
View File

@@ -0,0 +1,43 @@
---
tags: architecture,mobile, cms, db
---
# System architecture
## Description
it should have a family photo of used framework
## Diagram
```mermaid {align="center"}
architecture-beta
group running_config(logos:aws-opsworks)[running_config]
service db(database)[pocketbase] in running_config
service tra1(internet)[incoming traffic 3000] in running_config
service cms(logos:nextjs)[next app] in running_config
service tra2(internet)[incoming traffic 5173] in running_config
service ionic(logos:ionic)[ionic app] in running_config
tra1:R --> L:cms
cms:R --> L:db
tra2:R --> L:ionic
ionic:R --> B:db
%% group planning(logos:aws-lambda)[planning]
%% service api_ts(logos:aws-lambda)[api_ts] in planning
%% service pg_db(logos:postgresql)[pg_db] in planning
%% ui:R --> L:api_ts
%% ionic:R --> L:api_ts
%% api_ts:B --> T:pg_db
%% service task_server(logos:aws-lambda)[task_server] in planning
%% api_ts:R --> L:task_server
%% service marketing(logos:wordpress-icon)[marketing] in planning
```

2
001_documentation/Requirements/index.md
View File

@@ -19,3 +19,5 @@
- [REQ0015: pocketbase json schema to dbml converter](./REQ0015/index.md) - [REQ0015: pocketbase json schema to dbml converter](./REQ0015/index.md)
- [REQ0016: login flow](./REQ0016/index.md) - [REQ0016: login flow](./REQ0016/index.md)
- [REQ0017: lesson page documentation](./REQ0017/index.md) - [REQ0017: lesson page documentation](./REQ0017/index.md)
- [REQ0018: family photo of frameworks](./REQ0018/index.md)
- [REQ0019: System architecture](./REQ0019/index.md)