https://github.com/polyneue/hubblejs-docs
The official documentation site for HubbleJS
https://github.com/polyneue/hubblejs-docs
developer documentation generator hubblejs portfolio
Last synced: about 2 months ago
JSON representation
The official documentation site for HubbleJS
- Host: GitHub
- URL: https://github.com/polyneue/hubblejs-docs
- Owner: Polyneue
- License: mit
- Created: 2018-07-29T13:50:22.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-04-28T04:32:06.000Z (about 2 years ago)
- Last Synced: 2025-02-01T15:11:14.204Z (4 months ago)
- Topics: developer, documentation, generator, hubblejs, portfolio
- Language: JavaScript
- Homepage: https://polyneue.com/hubblejs-docs
- Size: 2.13 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# hubblejs.com
This site uses a modified version of [Flatdoc](https://github.com/rstacruz/flatdoc) to load in the README.md file from the [HubbleJS](https://github.com/Polyneue/hubblejs) repo.
## Developing
The current build is simple, start by installing the dependencies:
```
$ npm install
```
Then, run two separate processes that will compile the CSS and start a server on `http://localhost:1313`
```
$ npm run build
$ npm run serve
```
## Deploying
The site is automatically deployed when commits land in `master`, via [Github Pages](https://pages.github.com/).
## TODO:
* Create build process for JS
* Switch from Stylus to SCSS
* Remove flatdoc for a lighter weight version