Skip to content

Commit c398e03

Browse files
tarasposptgott
andauthored
Improve readme (#19)
* Improve readme * Update README.md * Apply suggestions from code review Co-authored-by: Paul Gottschling <paul.gottschling@gmail.com>
1 parent fc32918 commit c398e03

File tree

1 file changed

+20
-22
lines changed

1 file changed

+20
-22
lines changed

README.md

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -68,23 +68,21 @@ Everything else is more or less straightforward Docusaurus code.
6868

6969
### Folder structure
7070

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.
8482

8583
### `config.json` format
8684

87-
```
85+
```typescript
8886
type Version = {
8987
name: string; // should be the same as the folder in `content`
9088
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
104102
105103
### CLI commands
106104
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+
- `yarn git-update` – update git submodules.
106+
- `yarn prepare-files` – copy files from `content` to folders used by Docusaurus.
107+
- `yarn prepare-sanity-data` - fetching and saving data from Sanity CMS.
108+
- `yarn start` – start server in dev mode.
109+
- `yarn build` - buld static site.
110+
- `yarn swizzle` - used to eject files from the default Docusaurus theme to the `src/theme` folder. See [swizzling](https://docusaurus.io/docs/swizzling).
111+
- `yarn serve` – server static files.
112+
- `yarn typecheck` - check types.
115113
116114
For other commands see [Docusaurus docs](https://docusaurus.io/docs/cli#docusaurus-cli-commands).

0 commit comments

Comments
 (0)