Skip to content

Commit 156f83a

Browse files
committed
Update README: explain basic project structure and sidebar configuration
1 parent fdde48f commit 156f83a

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,32 @@
22

33
Documentation of [AsTeRICS](https://github.com/asterics/AsTeRICS.git).
44

5+
## Configuration
6+
7+
`asterics-docs` is a [VuePress](https://vuepress.vuejs.org/) based project that uses a theme based on the [Default Theme](https://ecosystem.vuejs.press/themes/default/config.html).
8+
Hence, all configuration provided by the *Default Theme* of *VuePress* is available in the custom theme.
9+
10+
::: warning
11+
12+
The (true) sources of all VuePress configuration files are located at `src/vuepress/`and `src/vuepress/config`.
13+
14+
After setting up the project for editing, building and releasing, `asterics-docs` copies all relevant files in the folder `docs/`.
15+
The source files for the VuePress configuration are copied to `docs/.vuepress` during this process.
16+
17+
:::
18+
19+
### Sidebar
20+
21+
The configration for the sidebar is specified in `src/vuepress/config.js` and in the folder `src/vuepress/config/sidebar/`.
22+
23+
In addition to the [sidebar configuration of the VuePress Default Theme](https://ecosystem.vuejs.press/themes/default/config.html#sidebar), this project contains helper function to assist or automate this process:
24+
25+
* `loadSingleSidebar`: Loads markdown files from a single directory (excluding subdirectories)
26+
* `loadSidebarFrom`: Creates multi-level navigation for directories with nested content
27+
* `loadSidebarFromWithPath`: Creates a flat list of links from a single directory
28+
29+
For better understanding, compare their usage within the existing configuration.
30+
531
## GitHub Workflows
632

733
This repository provides following workflows:

0 commit comments

Comments
 (0)