HPCE/gitea-pages
0
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Activity

Merge branch 'gh-pages' of https://github.com/tomjoht/documentation-theme-jekyll into gh-pages

Browse Source
This commit is contained in:
Tom Johnson
2019-01-16 14:05:49 -08:00
parent 2abfd8bdba 6e6fd8d475
commit c5447b1ba0
2 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
index.md
View File

@ -15,7 +15,7 @@ Follow these instructions to build the theme.
### 1. Download the theme
First download or clone the theme from the [Github repo](https://github.com/tomjoht/documentation-theme-jekyll). Most likely you won't be pulling in updates once you start customizing the theme, so downloading the theme (instead of cloning it) probably makes the most sense. In Github, click the **Clone or download** button, and then click **Download ZIP**.
First, download or clone the theme from the [Github repo](https://github.com/tomjoht/documentation-theme-jekyll). Most likely you won't be pulling in updates once you start customizing the theme, so downloading the theme (instead of cloning it) probably makes the most sense. In Github, click the **Clone or download** button, and then click **Download ZIP**.
### 2. Install Jekyll
@ -151,9 +151,9 @@ The top navigation works just like the sidebar. You can specify which topnav dat
topnav: topnav
```
Here the topnav refers to the \_data/topnav.yml file.
Here the topnav refers to the `_data/topnav.yml` file.
Because most topnav options will be the same, the \_config.yml file specifies the topnav file as a default:
Because most topnav options will be the same, the `_config.yml` file specifies the topnav file as a default:
```yaml
-
@ -170,7 +170,7 @@ Because most topnav options will be the same, the \_config.yml file specifies th
## Sidebar syntax
The sidebar data file uses a specific YAML syntax that you must follow. Follow the sample pattern shown in the theme, specically looking at mydoc_sidebar.yml as an example: Here's a code sample showing all levels:
The sidebar data file uses a specific YAML syntax that you must follow. Follow the sample pattern shown in the theme, specically looking at `mydoc_sidebar.yml` as an example: Here's a code sample showing all levels:
```yaml
entries:

3
pages/mydoc/mydoc_sidebar_navigation.md
View File

@ -46,7 +46,8 @@ For example, the sidebar.html file contains the following code:
{% raw %}
```liquid
{% if folderitem.external_url %}
<li><a href="{{folderitem.external_url}}" target="_blank">{{folderitem.title}}</a></li>```
<li><a href="{{folderitem.external_url}}" target="_blank">{{folderitem.title}}</a></li>
```
{% endraw %}
You can see that the `external_url` is a condition that applies a different formatting. Although this feature is available, I recommend putting any external navigation links in the top navigation bar instead of the side navigation bar.