Skip to content

Commit 94dd4cd

Browse files
vdyedscho
vdye
authored and
dscho
committed
Adjust the "references" page to Hugo
The categories shown on the references page are added to `data/` and used via the new `category` shortcode. This new shortcode is actually only a shim that hands off to the new `category` partial layout; This is done in that manner to allow reusing the latter in the upcoming commit where the `Topics` drop-down of the manual pages is populated. Signed-off-by: Victoria Dye <[email protected]> Signed-off-by: Johannes Schindelin <[email protected]>
1 parent cea0c60 commit 94dd4cd

File tree

16 files changed

+205
-157
lines changed

16 files changed

+205
-157
lines changed

‎data/doc_categories/admin.yml‎

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1-
<h3 class='admin'>Administration</h3>
2-
<ul class='unstyled'>
3-
<li><%= man('git-clean') %></li>
4-
<li><%= man('git-gc') %></li>
5-
<li><%= man('git-fsck') %></li>
6-
<li><%= man('git-reflog') %></li>
7-
<li><%= man('git-filter-branch') %></li>
8-
<li><%= man('git-instaweb') %></li>
9-
<li><%= man('git-archive') %></li>
10-
<li><%= man('git-bundle') %></li>
11-
</ul>
1+
---
2+
category_id: "admin"
3+
name: "Administration"
4+
commands:
5+
- doc: "git-clean"
6+
- doc: "git-gc"
7+
- doc: "git-fsck"
8+
- doc: "git-reflog"
9+
- doc: "git-filter-branch"
10+
- doc: "git-instaweb"
11+
- doc: "git-archive"
12+
- doc: "git-bundle"
13+
---

‎data/doc_categories/branching.yml‎

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
1-
<h3 class='branching'>Branching and Merging</h3>
2-
<ul class='unstyled'>
3-
<li><%= man('git-branch') %></li>
4-
<li><%= man('git-checkout') %></li>
5-
<li><%= man('git-switch') %></li>
6-
<li><%= man('git-merge') %></li>
7-
<li><%= man('git-mergetool') %></li>
8-
<li><%= man('git-log') %></li>
9-
<li><%= man('git-stash') %></li>
10-
<li><%= man('git-tag') %></li>
11-
<li><%= man('git-worktree') %></li>
12-
</ul>
1+
---
2+
category_id: "branching"
3+
name: "Branching and Merging"
4+
commands:
5+
- doc: "git-branch"
6+
- doc: "git-checkout"
7+
- doc: "git-switch"
8+
- doc: "git-merge"
9+
- doc: "git-mergetool"
10+
- doc: "git-log"
11+
- doc: "git-stash"
12+
- doc: "git-tag"
13+
- doc: "git-worktree"
14+
---

‎data/doc_categories/debugging.yml‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
<h3 class='debugging'>Debugging</h3>
2-
<ul class='unstyled'>
3-
<li><%= man('git-bisect') %></li>
4-
<li><%= man('git-blame') %></li>
5-
<li><%= man('git-grep') %></li>
6-
</ul>
1+
---
2+
category_id: "debugging"
3+
name: "Debugging"
4+
commands:
5+
- doc: "git-bisect"
6+
- doc: "git-blame"
7+
- doc: "git-grep"
8+
---

‎data/doc_categories/email.yml‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
<h3 class='email'>Email</h3>
2-
<ul class='unstyled'>
3-
<li><%= man('git-am') %></li>
4-
<li><%= man('git-apply') %></li>
5-
<li><%= man('git-format-patch') %></li>
6-
<li><%= man('git-send-email') %></li>
7-
<li><%= man('git-request-pull') %></li>
8-
</ul>
1+
---
2+
category_id: "email"
3+
name: "Email"
4+
commands:
5+
- doc: "git-am"
6+
- doc: "git-apply"
7+
- doc: "git-format-patch"
8+
- doc: "git-send-email"
9+
- doc: "git-request-pull"
10+
---

‎data/doc_categories/external.yml‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
<h3 class='external'>External Systems</h3>
2-
<ul class='unstyled'>
3-
<li><%= man('git-svn') %></li>
4-
<li><%= man('git-fast-import') %></li>
5-
</ul>
1+
---
2+
category_id: "external"
3+
name: "External Systems"
4+
commands:
5+
- doc: "git-svn"
6+
- doc: "git-fast-import"
7+
---

‎data/doc_categories/guides.yml‎

Lines changed: 29 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,29 @@
1-
<h3 class='guides'>Guides</h3>
2-
<ul class='unstyled'>
3-
<li><%= man('gitattributes') %></li>
4-
<li><%= man('gitcli', 'Command-line interface conventions') %></li>
5-
<li><%= man('giteveryday', 'Everyday Git') %></li>
6-
<li><%= man('gitfaq', 'Frequently Asked Questions (FAQ)') %></li>
7-
<li><%= man('gitglossary', 'Glossary') %></li>
8-
<li><%= man('githooks', 'Hooks') %></li>
9-
<li><%= man('gitignore') %></li>
10-
<li><%= man('gitmodules') %></li>
11-
<li><%= man('gitrevisions', 'Revisions') %></li>
12-
<li><%= man('gitsubmodules', 'Submodules') %></li>
13-
<li><%= man('gittutorial', 'Tutorial') %></li>
14-
<li><%= man('gitworkflows', 'Workflows') %></li>
15-
<li><a href="/docs/git#_guides">All guides...</a></li>
16-
</ul>
1+
---
2+
category_id: "guides"
3+
name: "Guides"
4+
commands:
5+
- doc: "gitattributes"
6+
- doc: "gitcli"
7+
title: "Command-line interface conventions"
8+
- doc: "giteveryday"
9+
title: "Everyday Git"
10+
- doc: "gitfaq"
11+
title: "Frequently Asked Questions (FAQ)"
12+
- doc: "gitglossary"
13+
title: "Glossary"
14+
- doc: "githooks"
15+
title: "Hooks"
16+
- doc: "gitignore"
17+
- doc: "gitmodules"
18+
- doc: "gitrevisions"
19+
title: "Revisions"
20+
- doc: "gitsubmodules"
21+
title: "Submodules"
22+
- doc: "gittutorial"
23+
title: "Tutorial"
24+
- doc: "gitworkflows"
25+
title: "Workflows"
26+
- doc: "git#_guides"
27+
title: "All guides..."
28+
no_append_lang: true
29+
---

‎data/doc_categories/inspection.yml‎

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
<h3 class='inspection'>Inspection and Comparison</h3>
2-
<ul class='unstyled'>
3-
<li><%= man('git-show') %></li>
4-
<li><%= man('git-log') %></li>
5-
<li><%= man('git-diff') %></li>
6-
<li><%= man('git-difftool') %></li>
7-
<li><%= man('git-range-diff') %></li>
8-
<li><%= man('git-shortlog') %></li>
9-
<li><%= man('git-describe') %></li>
10-
</ul>
1+
---
2+
category_id: "inspection"
3+
name: "Inspection and Comparison"
4+
commands:
5+
- doc: "git-show"
6+
- doc: "git-log"
7+
- doc: "git-diff"
8+
- doc: "git-difftool"
9+
- doc: "git-range-diff"
10+
- doc: "git-shortlog"
11+
- doc: "git-describe"
12+
---

‎data/doc_categories/patching.yml‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
<h3 class='patching'>Patching</h3>
2-
<ul class='unstyled'>
3-
<li><%= man('git-apply') %></li>
4-
<li><%= man('git-cherry-pick') %></li>
5-
<li><%= man('git-diff') %></li>
6-
<li><%= man('git-rebase') %></li>
7-
<li><%= man('git-revert') %></li>
8-
</ul>
1+
---
2+
category_id: "patching"
3+
name: "Patching"
4+
commands:
5+
- doc: "git-apply"
6+
- doc: "git-cherry-pick"
7+
- doc: "git-diff"
8+
- doc: "git-rebase"
9+
- doc: "git-revert"
10+
---

‎data/doc_categories/plumbing.yml‎

Lines changed: 25 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,25 @@
1-
<h3 class='plumbing'>Plumbing Commands</h3>
2-
<ul class='unstyled'>
3-
<li><%= man('git-cat-file') %></li>
4-
<li><%= man('git-check-ignore') %></li>
5-
<li><%= man('git-checkout-index') %></li>
6-
<li><%= man('git-commit-tree') %></li>
7-
<li><%= man('git-count-objects') %></li>
8-
<li><%= man('git-diff-index') %></li>
9-
<li><%= man('git-for-each-ref') %></li>
10-
<li><%= man('git-hash-object') %></li>
11-
<li><%= man('git-ls-files') %></li>
12-
<li><%= man('git-ls-tree') %></li>
13-
<li><%= man('git-merge-base') %></li>
14-
<li><%= man('git-read-tree') %></li>
15-
<li><%= man('git-rev-list') %></li>
16-
<li><%= man('git-rev-parse') %></li>
17-
<li><%= man('git-show-ref') %></li>
18-
<li><%= man('git-symbolic-ref') %></li>
19-
<li><%= man('git-update-index') %></li>
20-
<li><%= man('git-update-ref') %></li>
21-
<li><%= man('git-verify-pack') %></li>
22-
<li><%= man('git-write-tree') %></li>
23-
</ul>
1+
---
2+
category_id: "plumbing"
3+
name: "Plumbing Commands"
4+
commands:
5+
- doc: "git-cat-file"
6+
- doc: "git-check-ignore"
7+
- doc: "git-checkout-index"
8+
- doc: "git-commit-tree"
9+
- doc: "git-count-objects"
10+
- doc: "git-diff-index"
11+
- doc: "git-for-each-ref"
12+
- doc: "git-hash-object"
13+
- doc: "git-ls-files"
14+
- doc: "git-ls-tree"
15+
- doc: "git-merge-base"
16+
- doc: "git-read-tree"
17+
- doc: "git-rev-list"
18+
- doc: "git-rev-parse"
19+
- doc: "git-show-ref"
20+
- doc: "git-symbolic-ref"
21+
- doc: "git-update-index"
22+
- doc: "git-update-ref"
23+
- doc: "git-verify-pack"
24+
- doc: "git-write-tree"
25+
---

‎data/doc_categories/projects.yml‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
<h3 class='projects'>Getting and Creating Projects</h3>
2-
<ul class='unstyled'>
3-
<li><%= man('git-init') %></li>
4-
<li><%= man('git-clone') %></li>
5-
</ul>
1+
---
2+
category_id: "projects"
3+
name: "Getting and Creating Projects"
4+
commands:
5+
- doc: "git-init"
6+
- doc: "git-clone"
7+
---

0 commit comments

Comments
 (0)