File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Load diff This file was deleted.
Original file line number Diff line number Diff line change 1- # Jekyll Doc Theme
1+ # microROS web site
22
3- Go to [ the website] ( https://aksakalli.github.io/jekyll-doc-theme/ ) for detailed information and demo.
3+ This is the source for the microROS website, available
4+ at [ https://microros.github.io/ ] ( https://microros.github.io/ )
45
5- ## Running locally
6-
7- You need Ruby and gem before starting, then:
8-
9- ``` bash
10- # install bundler
11- gem install bundler
12-
13- # clone the project
14- git clone https://github.com/aksakalli/jekyll-doc-theme.git
15- cd jekyll-doc-theme
16-
17- # run jekyll with dependencies
18- bundle exec jekyll serve
19- ```
6+ ## Editing
207
21- ## Docker
8+ See [ editing instructions ] ( EDITING-INSTRUCTIONS.md )
229
23- Alternatively, you can deploy it using the multi-stage [ Dockerfile] ( Dockerfile )
24- that serves files from Nginx for better performance in production.
25-
26- Build the image for your site's ` JEKYLL_BASEURL ` :
27-
28- ```
29- docker build --build-arg JEKYLL_BASEURL="/" -t jekyll-doc-theme .
30- ```
10+ ## Running locally
3111
32- and serve it:
12+ To test locally, you need a local version of Jekyll, the site-generation
13+ engine used by Github Pages. See [ Jekyll Quickstart] ( https://jekyllrb.com/docs/ )
14+ for installation instructions.
3315
34- ```
35- docker run -p 8080:80 jekyll-doc-theme
16+ After installing Jekyll, install all dependencies by running
17+ ``` bash
18+ bundle install
3619```
3720
3821## License
3922
40- Released under [ the MIT license ] ( LICENSE ) .
23+ Released under [ the Apache Public License 2.0 ] ( LICENSE ) .
You can’t perform that action at this time.
0 commit comments