https://github.com/thepatrickniyo/doc.super-vite
The super-vite documentation
https://github.com/thepatrickniyo/doc.super-vite
documentation javascript super-vite vue vuepress
Last synced: 2 months ago
JSON representation
The super-vite documentation
- Host: GitHub
- URL: https://github.com/thepatrickniyo/doc.super-vite
- Owner: thepatrickniyo
- License: mit
- Created: 2021-12-31T00:19:07.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-02-16T20:15:13.000Z (over 4 years ago)
- Last Synced: 2026-02-08T19:54:54.269Z (5 months ago)
- Topics: documentation, javascript, super-vite, vue, vuepress
- Language: JavaScript
- Homepage: https://doc-super-vite.vercel.app/
- Size: 213 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# doc.super-vite
The super-vite documentation
## Quick start
✅ clone repo
✅ run `yarn install`
## Running
```sh
$ yarn dev
```
## Building
```sh
$ yarn build
```
### Adding a page
To be able to add a guide to this documentain
Create an `md` file add locate it under `/src/doc`
Then locate to be able to render the documentation file slightly modify `src/.vuepress/config` to add in your own file name
```js
...
sidebar: {
'/doc/': [
{
title: 'Documentation',
collapsable: false,
children: [
'',
'quick-start',
'layout',
'routing',
'linters',
'tests',
'modules',
'styles',
'redux-dev-tool',
'i18n',
'services',
'helpers',
'enums',
'interfaces',
'types',
'assets',
'plugins'
]
}
],
}
```
## Contributing
We welcome contribution via either PRs or Issues and ideas as well. Before contributing make sure you revise our [CODE OF CONDUCT](https://github.com/PatrickNiyogitare28/doc.super-vite/blob/master/CODE_OF_CONDUCT.md)
## Maintainer
patrickniyogitare28@gmail.com
## LICENSE
[MIT](https://github.com/PatrickNiyogitare28/doc.super-vite/blob/master/LICENSE)