49 |
50 |
51 |
52 |
53 |
54 |
55 | This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
56 |
--------------------------------------------------------------------------------
/docs/Gemfile:
--------------------------------------------------------------------------------
1 | source 'http://rubygems.org'
2 | gem 'github-pages', group: :jekyll_plugins
3 | gem "jekyll-gitlab-metadata" # for cross compatibility
--------------------------------------------------------------------------------
/docs/README.md:
--------------------------------------------------------------------------------
1 | ## Home Page
2 |
3 | This is the home page of the Wiki
4 |
5 | ## Attribution of this Wiki
6 |
7 | [git-wiki-skeleton](https://github.com/Drassil/git-wiki-skeleton): This is the repo that you should fork or use as a template. It uses the [jekyll remote theme](https://github.com/benbalter/jekyll-remote-theme) functionality that allows you to create your own wiki based on git-wiki-theme. By using the remote functionality you can automatically keep your wiki always updated with latest features from the **git-wiki-theme**, but you can also fully customize it.
8 |
--------------------------------------------------------------------------------
/docs/_config.yml:
--------------------------------------------------------------------------------
1 | remote_theme: Drassil/git-wiki-theme@master
2 | # (string) Title of your wiki
3 | title: "ReactJS-Template"
4 | # Repository name to allow successful building on Netlify
5 | repository: lucas2005gao/ReactJS-Template
6 |
7 | # (string) if you've installed your wiki in subfolder, you must change this configuration
8 | # with your folder name, otherwise leave it empty
9 | baseurl: "/ReactJS-Template"
10 | # (string) Description of your wiki
11 | description:
12 | # (boolean) Enable/disable wiki page list in sidebar
13 | show_wiki_pages: true
14 | # (integer) Maximum number of wiki page to shown in sidebar
15 | show_wiki_pages_limit: 10
16 | # (boolean) Enable/disable blog feature
17 | blog_feature: false
18 | # (boolean) Enable/disable wiki posts list in sidebar (needs blog_feature enabled)
19 | show_wiki_posts: false
20 | # (integer) Maximum number of wiki posts to shown in sidebar
21 | show_wiki_posts_limit: 10
22 | # from jekyll (read jekyll doc)
23 | paginate: 5
24 | paginate_path: "/blog/page:num"
25 | permalink: /blog/posts/:year/:month/:day/:title:output_ext
26 | # (boolean) Enable/disable download buttons in sidebar
27 | show_downloads: true
28 | # (string) Specify branch rendered by gitpages allowing wiki tool buttons to work
29 | git_branch: "master"
30 | # (string) Url of logo image, it can be full, absolute or relative.
31 | logo_url:
32 | # (string) The UA-XXXXX-Y code from google analytic to enable GA on your wiki
33 | google_analytics:
34 | # (string) folder where wiki pages are stored, it's needed for tool buttons
35 | wiki_folder: "wiki"
36 | # (boolean) if you're using github wiki as submodule then this config
37 | # must be enabled to allow tool buttons to work properly
38 | use_github_wiki: true
39 | # (boolean) Enable "Edit with Prose.io" button in tools, it's a 3rd party
40 | # service to edit github markdown pages easily
41 | use_prose_io: false
42 | # Select search_engine component from:
43 | # - js: it uses a built in javascript component that uses generated js object
44 | # - js_rss: it uses a built in javascript component that uses generated sitemap_full.xml to search inside your wiki with lunr library (slow and experimental)
45 | # - github : it uses internal github repository search
46 | # - google : it uses cse search bar, you need to configure google_cse_token
47 | #
48 | search_engine: "js"
49 | # Setting google custom search engine for google
50 | # cse search bar (https://cse.google.it/cse/)
51 | google_cse_token:
52 |
53 | # (string) path of site root. Normally it's must be empty because _config.yml resides in the root of your repository.
54 | # If you have _config.yml and your site in a subfolder, then change this config accordly
55 | site_root: ""
56 |
57 | #
58 | # Jekyll configurations
59 | #
60 |
61 | # You can customize it changing default layout for all pages
62 | # More info: https://jekyllrb.com/docs/configuration/
63 | #
64 | # git-wiki includes some internal themes that you can choose
65 | # check _layouts folder
66 | #
67 | markdown: kramdown
68 | highlighter: rouge
69 | kramdown:
70 | input: GFM
71 | syntax_highlighter: rouge
72 |
73 | defaults:
74 | - scope:
75 | path: "wiki"
76 | values:
77 | permalink: /:basename
78 | - scope:
79 | path: "" # an empty string here means all files in the project
80 | values:
81 | layout: "git-wiki-default"
82 | - scope:
83 | path: ""
84 | type: "pages"
85 | values:
86 | layout: "git-wiki-default"
87 | - scope:
88 | path: ""
89 | type: "posts"
90 | values:
91 | layout: "git-wiki-post"
92 | - scope:
93 | path: blog
94 | values:
95 | layout: "git-wiki-blog"
96 | sass:
97 | style: compressed
98 | plugins:
99 | - jekyll-avatar
100 | - jekyll-coffeescript
101 | - jekyll-default-layout
102 | - jekyll-feed
103 | - jekyll-gist
104 | - jekyll-paginate
105 | - jekyll-mentions
106 | - jekyll-optional-front-matter
107 | - jekyll-readme-index
108 | - jekyll-redirect-from
109 | - jekyll-remote-theme
110 | - jekyll-relative-links
111 | - jekyll-seo-tag
112 | - jekyll-sitemap
113 | - jekyll-titles-from-headings
114 | - jemoji
115 | - jekyll-gitlab-metadata
116 |
117 | #
118 | # INCLUDING HOOKS
119 | # They are optional, change them only if you need
120 | # Check wiki documentation to learn how they work
121 | #
122 |
123 | inc_before_toc:
124 | inc_after_toc:
125 | inc_before_content:
126 | inc_after_content:
127 | inc_before_footer:
128 | inc_after_footer:
129 | inc_before_head:
130 | inc_after_head:
131 | inc_before_meta:
132 | inc_after_meta:
133 | inc_before_scripts:
134 | inc_after_scripts:
135 | inc_before_styles:
136 | inc_after_styles:
137 | inc_before_header:
138 | inc_after_header:
139 | inc_before_tail:
140 | inc_after_tail:
141 | inc_before_tools:
142 | inc_after_tools:
143 |
144 | inc_before_page_list:
145 | inc_after_page_list: sidebar.html
146 | inc_before_post_list:
147 | inc_after_post_list:
148 |
--------------------------------------------------------------------------------
/docs/_includes/sidebar.html:
--------------------------------------------------------------------------------
1 | Menu (Edit):
2 |
3 |