https://github.com/codenomdev/bantucms-docs
Bantucms Developer Documentation
https://github.com/codenomdev/bantucms-docs
bantucms bantucms-docs documentation
Last synced: 3 months ago
JSON representation
Bantucms Developer Documentation
- Host: GitHub
- URL: https://github.com/codenomdev/bantucms-docs
- Owner: codenomdev
- Created: 2023-01-02T15:39:49.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-03-01T15:34:09.000Z (over 2 years ago)
- Last Synced: 2025-02-07T00:28:44.677Z (4 months ago)
- Topics: bantucms, bantucms-docs, documentation
- Language: HTML
- Homepage: https://devdocs.codenom.com
- Size: 5.57 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Bantucms Documentation
You can find the online version of the Bantucms documentation at [https://devdocs.codenom.com/](https://devdocs.codenom.com/).
## Contribution Guide
For contributing to the docs, you first need to set up the project,
- Fork the repository.
- Clone your fork.
- Follow the [Install Dependencies](#Install-dependencies) section.
Make sure your PR follows all these points,
- Before writing the docs just make sure to check that if that topic is already written or not.
- Make sure your markdown indentation should be proper. You can install `mark-down` lint also. This will help you to follow the markdown conventions.
- If you are creating new files for the docs, then make sure the filename should be `kebab-case`. For e.g. `file-1.md`, `file-2.md`.
## Install dependencies
- Run the following command,
~~~sh
npm install
~~~
- Run the docs locally,
~~~sh
npm run docs:dev
~~~
- Open your browser and go to [http://localhost:8080](http://localhost:8080).