|
1 |
| -# Jekyll Doc Theme |
2 |
| - |
3 |
| -Go to [the website](https://aksakalli.github.io/jekyll-doc-theme/) for detailed information and demo. |
4 |
| - |
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 |
| -``` |
20 |
| - |
21 |
| -## Docker |
22 |
| - |
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="/your-base/url" -t jekyll-doc-theme . |
30 |
| -``` |
31 |
| - |
32 |
| -(or leave it empty for root: `JEKYLL_BASEURL=""`) and serve it: |
33 |
| - |
34 |
| -``` |
35 |
| -docker run -p 8080:80 jekyll-doc-theme |
36 |
| -``` |
37 |
| - |
38 |
| -## Projects using Jekyll Doc Theme |
39 |
| - |
40 |
| -* http://teavm.org/ |
41 |
| -* https://su2code.github.io/ |
42 |
| -* https://launchany.github.io/mvd-template/ |
43 |
| -* https://knowit.github.io/kubernetes-workshop/ |
44 |
| -* https://rec.danmuji.org/ |
45 |
| -* https://nethesis.github.io/icaro/ |
46 |
| -* http://ai.cs.ucl.ac.uk/ |
47 |
| -* http://tizonia.org |
48 |
| -* https://lakka-switch.github.io/documentation/ |
49 |
| -* https://cs.anu.edu.au/cybersec/issisp2018/ |
50 |
| -* http://www.channotation.org/ |
51 |
| -* http://nemo.apache.org/ |
52 |
| -* https://csuf-acm.github.io/ |
53 |
| -* https://extemporelang.github.io/ |
54 |
| -* https://media-ed-online.github.io/intro-web-dev-2018spr/ |
55 |
| -* https://midlevel.github.io/MLAPI/ |
56 |
| -* https://pulp-platform.github.io/ariane/docs/home/ |
57 |
| -* https://koopjs.github.io/ |
58 |
| -* https://developer.apiture.com/ |
59 |
| -* https://contextmapper.github.io/ |
60 |
| -* https://www.bruttin.com/CosmosDbExplorer/ |
61 |
| -* http://mosaic-lopow.github.io/dash7-ap-open-source-stack/ |
62 |
| -* http://www.vstream.ml/ |
63 |
| -* http://docs.fronthack.com/ |
64 |
| -* https://repaircafeportsmouth.org.uk/ |
65 |
| -* http://brotherskeeperkenya.com/ |
66 |
| -* https://hschne.at/Fluentast/ |
67 |
| -* https://zoe-analytics.eu/ |
68 |
| -* https://uli.kmz-brno.cz/ |
69 |
| -* https://lime.software/ |
70 |
| -* https://weft.aka.farm |
71 |
| -* https://microros.github.io/ |
72 |
| -* https://citystoriesucla.github.io/citystories-LA-docs |
73 |
| -* http://lessrt.org/ |
74 |
| -* http://kivik.io/ |
75 |
| -* https://www.iot-kit.nl/ |
76 |
| -* http://justindietz.com/ |
77 |
| -* https://universalsplitscreen.github.io/ |
78 |
| -* https://docs.oneflowcloud.com/ |
79 |
| -* https://actlist.silentsoft.org/ |
80 |
| - |
81 |
| -## License |
82 |
| - |
83 |
| -Released under [the MIT license](LICENSE). |
| 1 | +# CodingApi |
0 commit comments