-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathmkdocs.yml
145 lines (138 loc) · 3.66 KB
/
mkdocs.yml
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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
# Project information
site_name: "Madrus's Docs"
site_description: 'A short description of my project'
site_author: Madrus
site_url: 'http://madrus4u.com/mdocs/'
# Repository
repo_name: madrus/mdocs
repo_url: https://github.com/madrus/mdocs
edit_uri: ''
#Copyright
copyright: 'Copyright © 2018 <a href="https://madrus4u.com">Madrus4U</a>'
# Documentation and theme
theme:
name: 'material'
language: en
# feature:
# tabs: true
palette:
primary: 'blue grey'
accent: 'lime'
custom_dir: theme
favicon: 'img/favicon.ico'
logo: 'img/logo.png'
# Don't include MkDocs' JavaScript
include_search_page: false
search_index_only: true
extra_css:
- 'assets/stylesheets/extra.css'
- 'https://use.fontawesome.com/releases/v5.3.1/css/all.css'
- 'https://use.fontawesome.com/releases/v5.3.1/css/v4-shims.css'
extra_javascript:
- 'https://use.fontawesome.com/releases/v5.3.1/js/all.js'
- 'https://use.fontawesome.com/releases/v5.3.1/js/v4-shims.js'
# Options
extra:
version: 0.3.0
logo: 'img/logo.png'
palette:
primary: 'blue grey'
accent: 'deep orange'
font:
text: 'Roboto'
code: 'Roboto Mono'
i18n:
prev: 'Previous'
next: 'Next'
author:
github: 'madrus'
twitter: 'madrusnl'
# Google Analytics
google_analytics:
- 'UA-52692182-5'
- 'auto'
# Extensions
markdown_extensions:
- fenced_code
- fontawesome_markdown
- markdown.extensions.admonition
- markdown.extensions.codehilite:
guess_lang: false
linenums: true
- markdown.extensions.def_list
- markdown.extensions.footnotes
- markdown.extensions.meta
- markdown.extensions.nl2br
- markdown.extensions.smarty:
smart_angled_quotes: true
- markdown.extensions.toc:
permalink: true
- pymdownx.arithmatex
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.emoji:
emoji_generator: !!python/name:pymdownx.emoji.to_svg
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
# Pages structure
nav:
- Home: index.md
- MkDocs Engine:
- Getting started: engine/start.md
- Markdown Cheatsheet: engine/cheatsheet.md
- Custom Styling: engine/styling.md
- Color Styling: engine/colors.md
- PowerShell Deployments: engine/deployments.md
- Installation: engine/install.md
- Technicalities: engine/technicalities.md
- Aurelia:
- Some Technical Notes: aurelia/technicalities.md
- Dev Stuff:
- Dev Servers: dev/devServers.md
- Monorepos with Lerna: dev/monorepos.md
- NPX tool: dev/npx.md
- TODOs: dev/todo.md
- Git:
- GitFlow: git/gitflow.md
- Git Prompt Styling: git/styling.md
- Set up SSH: git/ssh.md
- Git Command Line Tools: git/tools.md
- GitDiff: git/gitdiff.md
- Go:
- Installing Go: go/myinstall.md
- Go Notes: go/notes.md
- GraphQL:
- 10 Principles: graphql/ten_principles.md
- Handy Stuff:
- Chocolatey: handy/choco.md
- Mac:
- Homebrew: mac/brew.md
- NGINX: mac/nginx.md
- SSH on Sierra: mac/ssh.md
- Tips & Tricks: mac/tips.md
- .NET Core:
- New Project: dotnet/new_project.md
- Notes: dotnet/notes.md
- Tips: dotnet/tips.md
- PowerShell:
- Debugging PowerShell in VS Code: powershell/vscode.md
- React:
- Linting: react/linting.md
- Material-UI for React: react/material-ui.md
- MDX Tools: react/mdx.md
- Performance Considerations: react/performance.md
- Redux: react/redux.md
- Vue.js:
- Vue.js Basics: vuejs/basics.md
- Webpack:
- Webpack Basics: webpack/basics.md