Pour tout problème contactez-nous par mail : support@froggit.fr | La FAQ :grey_question: | Rejoignez-nous sur le Chat :speech_balloon:

Skip to content
Snippets Groups Projects
Commit fac14075 authored by HGouttebroze's avatar HGouttebroze
Browse files

add tree structure and links to details

parent 9e57e9d7
No related branches found
No related tags found
2 merge requests!17Resolve "(doc) tree structure",!11Resolve "add Features on index"
Pipeline #2515 passed
This commit is part of merge request !18. Comments created here will be created in the context of that merge request.
......@@ -39,3 +39,40 @@ If you are using GitHub pages for hosting, this command is a convenient way to b
## Create a new section
[Follow this doc](doc/sections.md).
## Three structure
```
├── babel.config.js // contains configurations to Babel, a JavaScript compiler
├── blog // contains the blog Markdown files.
│ ├── 2019-05-28-hola.md
├── doc // contains the Markdown files for the Froggit docs.
│ └── pages.md // how create new pages
├── docs // contains the Markdown files for the docs.
│ ├── intro.md
│ ├── tutorial-basics
│ └── tutorial-extras
├── docusaurus.config.js // a config file containing the site configuration.
├── package.json // a Docusaurus website is a React app. You can install and use any npm packages
├── README.md
├── sidebars.js // used by the
documentation to specify the order of documents in the sidebar
├── src // non-documentation files like pages or custom React components
│ ├── components // contains React reusable Components and it's CSS modules
│ ├── css // global CSS
│ └── pages // pages Components
├── static // static directory
│ └── img // images folder
```
More details on Project structure:
* `/blog/` - You can delete the directory if you do not want/need a blog. More details can be found in the [blog guide](https://docusaurus.io/docs/blog)
* `/docs/` - Customize the order in sidebars.js. More details can be found in the [docs guide](https://docusaurus.io/docs/docs-markdown-features)
* `/src/` - You don't have to strictly put your non-documentation files in here but putting them under a centralized directory makes it easier to specify in case you need to do some sort of linting/processing
* `/src/pages` - More details can be found in the [pages guide](https://docusaurus.io/docs/creating-pages)
* `/static/` - Any contents inside here will be copied into the root of the final `build` directory
* `/docusaurus.config.js` - This is the equivalent of `siteConfig.js` in Docusaurus v1
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment