You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-22Lines changed: 20 additions & 22 deletions
Original file line number
Diff line number
Diff line change
@@ -68,23 +68,21 @@ Everything else is more or less straightforward Docusaurus code.
68
68
69
69
### Folder structure
70
70
71
-
`content` – folder for docs content.
72
-
`scripts` – helper CLI scripts.
73
-
`server` – code for plugins, and config parsing.
74
-
`src` - forntend-related files.
75
-
`src/component` – components ported from the old site, mostly header-related.
76
-
`src/styles` – css used in header.
77
-
`src/theme` – overrides for default theme files of Docusaurus
78
-
`src/utls` – client-side utils.
79
-
`staitc` - static files for the site: manifests, favicons, etc.
80
-
81
-
`docs`, `versioned_docs` are `versioned_sidebars` – folders for docs content that will be automatically populated by script.
82
-
83
-
`data` is a folder for sanity content.
71
+
-`content` – pre-migration docs content.
72
+
-`scripts` – helper CLI scripts.
73
+
-`server` – code for plugins and config parsing.
74
+
-`src` - frontend-related files.
75
+
-`src/component` – components ported from the old site, mostly header-related.
76
+
-`src/styles` – CSS used in the site header.
77
+
-`src/theme` – overrides for the default theme files of Docusaurus.
78
+
-`src/utils` – client-side utils.
79
+
-`static` - static files for the site: manifests, favicons, etc.
80
+
-`docs`, `versioned_docs` and `versioned_sidebars` – folders for Docusaurus site content that will be automatically populated by a script (`yarn prepare-files`).
81
+
-`data` is a folder for content pulled from Sanity CMS.
84
82
85
83
### `config.json` format
86
84
87
-
```
85
+
```typescript
88
86
typeVersion= {
89
87
name:string; // should be the same as the folder in `content`
90
88
branch:string; // name of the original git branch
@@ -104,13 +102,13 @@ If no versions are marked as `current`/`latest`, last version in alphabetical or
104
102
105
103
### CLI commands
106
104
107
-
`yarn git-update` – update git modules.
108
-
`yarn prepare-files` – copy files from `content` to docusaurus folders.
109
-
`yarn prepare-sanity-data` - fetching and saving data form navigation for Sanity.
110
-
`yarn start` – start server in dev mode.
111
-
`yarn build` - buld static site.
112
-
`yarn swizzle` - used to eject files from default Docusaurus theme to `src/theme` folder. `see[swizzling](https://docusaurus.io/docs/swizzling).
113
-
`yarn serve` – server static files.
114
-
`yarn typecheck` - check types.
105
+
- `yarngit-update` – update git submodules.
106
+
- `yarnprepare-files` – copy files from `content` to folders used by Docusaurus.
107
+
- `yarnprepare-sanity-data` - fetching and saving data from Sanity CMS.
108
+
- `yarnstart` – start server in dev mode.
109
+
- `yarnbuild` - buld static site.
110
+
- `yarnswizzle` - used to eject files from the default Docusaurus theme to the `src/theme` folder. See [swizzling](https://docusaurus.io/docs/swizzling).
111
+
- `yarnserve` – server static files.
112
+
- `yarntypecheck` - check types.
115
113
116
114
For other commands see [Docusaurus docs](https://docusaurus.io/docs/cli#docusaurus-cli-commands).
0 commit comments