forked from may-den/doc-store-template
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path.template
40 lines (25 loc) · 1.3 KB
/
.template
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# Template Document Git repo
This template can be cloned and used to make a document store repo in Git,
all folders should have a `.template` file. The `.template` file will get used as
the index header.
This is also now a Github template, https://help.github.com/en/articles/creating-a-repository-from-a-template
All files should use markdown, as github will reder them as HTML.
you then have change tracking of all files.
Before pushing to github, please run the mkindex.sh script to rebuild the index pages. `./mkindex.sh`
Please move the post-merge.hook to the ./.git/hooks/ directory, this will auto build indexes whe you pull updates. `mv post-merge.hook .git/hooks/post-merge`
## tools
There are two tools in this repo
- `mkdir` will make a new directory and create a template file
- `mkindex` will rebuild the index files, please run this before you commit!
## Page tags
Do you need to have your page searchable by other words?
Wish you could add tags?
Well your wish is now answered, just add the below code to your page (to or bottom)
```
<!--
tags: this, will , get added, to , the, end, of, your, page, link
-->
```
## code comments
If you include any code in a page, please use the right [language](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml) as it will colour code.
----