# Development Guide
# Directory structure Docs π
βββdocs
β βββ deploy.sh
β βββ package.json
β βββ src
β βΒ Β βββ public
β βΒ Β βΒ Β βββ image1.png
β βΒ Β βΒ Β βββ image2.png
β βΒ Β βββ .vuepress
β βΒ Β βΒ Β βββ Components
β βΒ Β βΒ Β βΒ Β βββ ABC.vue
β βΒ Β βΒ Β βΒ Β βββ Anchor.vue
β βΒ Β βΒ Β βΒ Β βββ index.js
β βΒ Β βΒ Β βββ Public
β βΒ Β βΒ Β βΒ Β βββ image1.png
β βΒ Β βΒ Β βΒ Β βββ image2.png
β βΒ Β βΒ Β βββ styles
β βΒ Β βΒ Β βΒ Β βββ abc.css
β βΒ Β βΒ Β βΒ Β βββ xyz.css
β βΒ Β βΒ Β βββ config.js
β βΒ Β βΒ Β βββ enhanceApp.js
β βΒ Β βΒ Β βββ index.js
β βΒ Β βββ Document folder type
β βΒ Β Β βββ README.md
β βΒ Β Β Β βββ xyz.md
β βββ tsconfig.json
βββREADME.md
βββyarn.lock
# Writing new documentation π
- Create a folder inside src with the name of the document name
- Create a
README.mdfile for default page content under the documentation - Create multiple files as
name.mdto create more content on the sidebar of the page - Update the
config.jsinside the.vuepressfolder as shown in the below code blocks
# Add to Nav example
{
text: 'Developer Guide',
link: '/developer-guide/'
}
# Add to sidebar example
'/prismic/': [
{
title: 'Prismic',
collapsable: false,
children: [
'',
'features', // files inside the document folder
]
}
],