https://github.com/guillainbisimwa/likelemba-doc
https://github.com/guillainbisimwa/likelemba-doc
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/guillainbisimwa/likelemba-doc
- Owner: guillainbisimwa
- License: apache-2.0
- Created: 2023-03-20T06:54:26.000Z (over 2 years ago)
- Default Branch: development
- Last Pushed: 2023-03-20T07:36:11.000Z (over 2 years ago)
- Last Synced: 2025-01-30T05:42:46.834Z (9 months ago)
- Language: JavaScript
- Size: 305 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
---
noteId: "5946a7d0add711ed8ba0d566f9e2e13f"
tags: []
---
Getting Started
---------------
### Prerequisites
You're going to need:
- **Node.js**
### Getting Set Up
1. Fork this repository on Github.
2. Clone *your forked repository* (not this original one) to your hard drive with `git clone https://github.com/YOURUSERNAME/node-slate.git`
3. `cd node-slate`
4. Initialize and start Slate:
```shell
npm install
npm run build
npm start
```
You can now see the docs at http://localhost:4567. Whoa! That was fast!
### Commands
Compile documentation to static site in `./build`:
```shell
npm run build
```
Run a dev server that live-reloads at http://localhost:4567:
```shell
npm start
```
Publish your docs to `origin/gh-pages` branch:
```shell
npm run deploy
```
Gulp Task
---------
Slate API documentation generation is also available as a Gulp task with the
[gulp-node-slate](https://github.com/center-key/gulp-node-slate) plugin.
---
[MIT License](LICENSE.txt)