https://github.com/albogdano/bootup
Bootstrap + Assemble starter kit for putting together static websites and documentation
https://github.com/albogdano/bootup
documentation-tool html-builder static-site-generator
Last synced: about 1 year ago
JSON representation
Bootstrap + Assemble starter kit for putting together static websites and documentation
- Host: GitHub
- URL: https://github.com/albogdano/bootup
- Owner: albogdano
- License: mit
- Created: 2014-03-27T10:58:19.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2020-03-15T10:39:20.000Z (about 6 years ago)
- Last Synced: 2025-04-04T05:06:50.313Z (about 1 year ago)
- Topics: documentation-tool, html-builder, static-site-generator
- Language: HTML
- Homepage:
- Size: 393 KB
- Stars: 10
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# bootUP [](https://travis-ci.org/albogdano/bootup)
> ### A [Bootstrap](http://getbootstrap.com) + [Assemble](http://assemble.io) + [HTML5 Boilerplate](http://html5boilerplate.com) starter kit.
## Features
With **bootUP** you can quickly build responsive static websites and iterate on them _without refreshing the browser_!
It contains some of the most widely used frontend tools and frameworks.
- [Bootstrap](http://getbootstrap.com) - CSS and JS framework
- [Assemble](http://assemble.io) - static site generator
- [HTML5 Boilerplate](http://html5boilerplate.com) - HTML5 barebones template
- [Grunt](http://http://gruntjs.com) - Javascript build tool
- [Bootswatch](http://bootswatch.com) - a collection of Bootstrap themes
- [Font Awesome](http://fontawesome.io) - icon font
## Demo Site
### [Para Docs](https://paraio.org/docs/)
## Requirements
Skip this part if you already have Node.js, Grunt and Bower on your machine.
1. Get [Node.js](http://nodejs.org/)
2. Install Grunt - `$ npm install -g grunt-cli`
3. Install Bower - `$ npm install -g bower`
## Getting Started
1. [Download](https://github.com/albogdano/bootup/archive/master.zip) bootUP **or** clone it.
2. `$ npm install`
3. `$ grunt server`
**Other tasks:**
- Build: `$ grunt`
- Clean: `$ grunt clean`
- Clean & Build: `$ grunt cb` (also validates HTML and Javascript)
**Note:** if you get the error `ENOSPC` Error on Linux, do this:
```bash
$ echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p
```
## Settings
### Google Analytics
Edit `assemble.json` and change `ga` to your tracking id and `domain` to match the domain you use for Google Analytics.
### Switching themes
Edit `assemble.json` and change `theme` to any of the Bootswatch theme names:
`amelia`, `cerulean`, `cosmo`, `cyborg`, `darkly`, `flatly`, `journal`, `lumen`, `readable`,
`simplex`, `slate`, `spacelab`, `superhero`, `united`, `yeti`
Use `default` for the vanilla Bootstrap style.
### Switching templates
Edit `assemble.json` and change `template` to one of the following:
`modern-business`, `grayscale`, `monolite`
Currently there are three templates to choose from:
- [Modern Business](http://startbootstrap.com/modern-business) - a full site Bootstrap template
- [Grayscale](http://startbootstrap.com/grayscale) - a nice black & white single page template
- Monolite - a Grayscale clone but lighter. Great as a template for documentation!
Feel free to add more templates by creating a pull request or you could just ask me politely :wink:
## License
[MIT License](LICENSE)