|
1 | | -# Docsy Jekyll Theme |
| 1 | +# Richard Gibert's Personal Website |
2 | 2 |
|
3 | | -[](https://circleci.com/gh/vsoch/docsy-jekyll/tree/master) |
4 | | -<a href="https://jekyll-themes.com/docsy-jekyll/"> |
5 | | - <img src="https://img.shields.io/badge/featured%20on-JT-red.svg" height="20" alt="Jekyll Themes Shield" > |
6 | | -</a> |
| 3 | +Welcome to the source code of my personal website. |
7 | 4 |
|
8 | | - |
| 5 | +## Tech Stack |
9 | 6 |
|
10 | | -This is a [starter template](https://vsoch.github.com/docsy-jekyll/) for a Docsy jekyll theme, based |
11 | | -on the Beautiful [Docsy](https://github.com/google/docsy) that renders with Hugo. This version is intended for |
12 | | -native deployment on GitHub pages. The original [Apache License](https://github.com/vsoch/docsy-jekyll/blob/master/LICENSE) is included. |
13 | | - |
14 | | -## Changes |
15 | | - |
16 | | -The site is intended for purely documentation, so while the front page banner |
17 | | -is useful for business or similar, this author (@vsoch) preferred to have |
18 | | -the main site page go directly to the Documentation view. Posts |
19 | | -are still provided via a feed. |
20 | | - |
21 | | -## Usage |
22 | | - |
23 | | -### 1. Get the code |
24 | | - |
25 | | -You can clone the repository right to where you want to host the docs: |
26 | | - |
27 | | -```bash |
28 | | -git clone https://github.com/vsoch/docsy-jekyll.git docs |
29 | | -cd docs |
30 | | -``` |
31 | | - |
32 | | -### 2. Customize |
33 | | - |
34 | | -To edit configuration values, customize the [_config.yml](https://github.com/vsoch/docsy-jekyll/blob/master/_config.yml). |
35 | | -To add pages, write them into the [pages](https://github.com/vsoch/docsy-jekyll/blob/master/pages) folder. |
36 | | -You define urls based on the `permalink` attribute in your pages, |
37 | | -and then add them to the navigation by adding to the content of [_data/toc.myl](https://github.com/vsoch/docsy-jekyll/blob/master/_data/toc.yml). |
38 | | -The top navigation is controlled by [_data/navigation.yml](https://github.com/vsoch/docsy-jekyll/blob/master/_data/navigation.yml) |
39 | | - |
40 | | -### 3. Options |
41 | | - |
42 | | -Most of the configuration values in the [_config.yml](https://github.com/vsoch/docsy-jekyll/blob/master/_config.yml) are self explanatory, |
43 | | -and for more details, see the [getting started page](https://vsoch.github.io/docsy-jekyll/docs/getting-started) |
44 | | -rendered on the site. |
45 | | - |
46 | | -### 4. Serve |
47 | | - |
48 | | -Depending on how you installed jekyll: |
49 | | - |
50 | | -```bash |
51 | | -jekyll serve |
52 | | -# or |
53 | | -bundle exec jekyll serve |
54 | | -``` |
55 | | - |
56 | | -### 5. Run as a container in dev or prod |
57 | | - |
58 | | -#### Software Dependencies |
59 | | - |
60 | | -If you want to run docsy jekyll via a container for development (dev) or production (prod) you can use containers. This approach requires installing [docker-ce](https://docs.docker.com/engine/install/ubuntu/) and [docker-compose](https://docs.docker.com/compose/install/). |
61 | | - |
62 | | -#### Customization |
63 | | - |
64 | | -Note that the [docker-compose.yml](docker-compose.yml) file is using the [jekyll/jekyll:3.8](https://hub.docker.com/r/jekyll/jekyll/tags) image. If you want to make your build more reproducible, you can specify a particular version for jekyll (tag). Note that at the development time of writing this documentation, the latest was tag 4.0.0, |
65 | | -and it [had a bug](https://github.com/fastai/fastpages/issues/267#issuecomment-620612896) that prevented the server from deploying. |
66 | | - |
67 | | -If you are deploying a container to production, you should remove the line to |
68 | | -mount the bundles directory to the host in the docker-compose.yml. Change: |
69 | | - |
70 | | -```yaml |
71 | | - volumes: |
72 | | - - "./:/srv/jekyll" |
73 | | - - "./vendor/bundle:/usr/local/bundle" |
74 | | - # remove "./vendor/bundle:/usr/local/bundle" volume when deploying in production |
75 | | -``` |
76 | | - |
77 | | -to: |
78 | | - |
79 | | -```yaml |
80 | | - volumes: |
81 | | - - "./:/srv/jekyll" |
82 | | -``` |
83 | | -
|
84 | | -This additional volume is optimal for development so you can cache the bundle dependencies, |
85 | | -but should be removed for production. |
86 | | -
|
87 | | -#### Start Container |
88 | | -
|
89 | | -Once your docker-compose to download the base container and bring up the server: |
90 | | -
|
91 | | -```bash |
92 | | -docker-compose up -d |
93 | | -``` |
94 | | - |
95 | | -You can then open your browser to [http://localhost:4000](http://localhost:4000) |
96 | | -to see the server running. |
97 | | - |
98 | | -> Node : changes `baseurl: ""` in _config.yml when you are running in local and prod according to the requirement. |
| 7 | +- [GitHub Pages](https://pages.github.com/) |
| 8 | +- [Jekyll](https://jekyllrb.com/) |
| 9 | +- [Docsy Jekyll Theme](https://vsoch.github.com/docsy-jekyll/) |
0 commit comments