Skip to content

Commit 38502b7

Browse files
mattmakaimattmakai
committed
update mkdocs page
1 parent b66bcf2 commit 38502b7

File tree

3 files changed

+40
-39
lines changed

3 files changed

+40
-39
lines changed

‎all.html‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4916,21 +4916,21 @@ <h2>Lektor resources</h2>
49164916
</ul>
49174917
<h1>MkDocs</h1>
49184918
<p><a href="http://www.mkdocs.org/">MkDocs</a>
4919-
(<a href="https://github.com/mkdocs/mkdocs/">source code</a>), pronounced
4920-
"<a href="https://twitter.com/_tomchristie/status/805861272076042241">McDocs</a>" with
4921-
a Scottish accent or perhaps "Make Docs" otherwise, is a static site
4922-
generator that combines Markdown content with
4923-
<a href="/jinja2.html">Jinja2 templates</a> to produce websites. MkDocs uses
4924-
a YAML configuration file and can optionally use themes to easy change the
4925-
look-and-feel of the documentation output.</p>
4919+
(<a href="https://github.com/mkdocs/mkdocs/">source code</a>)
4920+
is a static site generator that combines Markdown content with
4921+
<a href="/jinja2.html">Jinja2 templates</a> to produce websites.
4922+
MkDocs can be pronounced "McDocs" or "M-K Docs",
4923+
<a href="https://twitter.com/_tomchristie/status/805861272076042241">although the core committers do not have a strong preference</a>
4924+
one way or the other on the name's pronunciation.</p>
49264925
<p><a href="http://www.mkdocs.org/" style="border: none;"><img src="/img/mkdocs-logo.jpg" width="100%" alt="MkDocs static site and documentation generator logo." class="technical-diagram" style="border-radius:5px"></a></p>
49274926
<h2>What's great about MkDocs?</h2>
4928-
<p>MkDocs has three great features for a static site generator: </p>
4929-
<ol>
4930-
<li>search</li>
4931-
<li>easy configuration</li>
4932-
<li>drop-in themes</li>
4933-
</ol>
4927+
<p>MkDocs uses a YAML configuration file and can optionally use themes to
4928+
easy change the look-and-feel of the documentation output.</p>
4929+
<p>In addition to the easy configuration via a YAML file and the drop-in
4930+
themes, MkDocs also has a wonderful search feature. Search is often not
4931+
possible out of the box in other static site generators. With MkDocs search
4932+
can easily be added without plugins or code changes to the static site
4933+
generator.</p>
49344934
<div class="well see-also">MkDocs is an implementation of the <a href="/static-site-generator.html">static site generators</a> concept. Learn how the parts fit together in the <a href="/web-development.html">web development</a> chapter or view <a href="/table-of-contents.html">all topics</a>.</div>
49354935

49364936
<h2>MkDocs resources</h2>

‎mkdocs.html‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -38,21 +38,21 @@
3838
<div class="col-md-8">
3939
<h1>MkDocs</h1>
4040
<p><a href="http://www.mkdocs.org/">MkDocs</a>
41-
(<a href="https://github.com/mkdocs/mkdocs/">source code</a>), pronounced
42-
"<a href="https://twitter.com/_tomchristie/status/805861272076042241">McDocs</a>" with
43-
a Scottish accent or perhaps "Make Docs" otherwise, is a static site
44-
generator that combines Markdown content with
45-
<a href="/jinja2.html">Jinja2 templates</a> to produce websites. MkDocs uses
46-
a YAML configuration file and can optionally use themes to easy change the
47-
look-and-feel of the documentation output.</p>
41+
(<a href="https://github.com/mkdocs/mkdocs/">source code</a>)
42+
is a static site generator that combines Markdown content with
43+
<a href="/jinja2.html">Jinja2 templates</a> to produce websites.
44+
MkDocs can be pronounced "McDocs" or "M-K Docs",
45+
<a href="https://twitter.com/_tomchristie/status/805861272076042241">although the core committers do not have a strong preference</a>
46+
one way or the other on the name's pronunciation.</p>
4847
<p><a href="http://www.mkdocs.org/" style="border: none;"><img src="/img/mkdocs-logo.jpg" width="100%" alt="MkDocs static site and documentation generator logo." class="technical-diagram" style="border-radius:5px"></a></p>
4948
<h2>What's great about MkDocs?</h2>
50-
<p>MkDocs has three great features for a static site generator: </p>
51-
<ol>
52-
<li>search</li>
53-
<li>easy configuration</li>
54-
<li>drop-in themes</li>
55-
</ol>
49+
<p>MkDocs uses a YAML configuration file and can optionally use themes to
50+
easy change the look-and-feel of the documentation output.</p>
51+
<p>In addition to the easy configuration via a YAML file and the drop-in
52+
themes, MkDocs also has a wonderful search feature. Search is often not
53+
possible out of the box in other static site generators. With MkDocs search
54+
can easily be added without plugins or code changes to the static site
55+
generator.</p>
5656
<div class="well see-also">MkDocs is an implementation of the <a href="/static-site-generator.html">static site generators</a> concept. Learn how the parts fit together in the <a href="/web-development.html">web development</a> chapter or view <a href="/table-of-contents.html">all topics</a>.</div>
5757

5858
<h2>MkDocs resources</h2>

‎source/content/pages/07-web-development/31-mkdocs.markdown‎

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,24 +9,25 @@ meta: MkDocs is a static site generator built in Python that is intended for cre
99

1010
# MkDocs
1111
[MkDocs](http://www.mkdocs.org/)
12-
([source code](https://github.com/mkdocs/mkdocs/)), pronounced
13-
"[McDocs](https://twitter.com/_tomchristie/status/805861272076042241)" with
14-
a Scottish accent or perhaps "Make Docs" otherwise, is a static site
15-
generator that combines Markdown content with
16-
[Jinja2 templates](/jinja2.html) to produce websites. MkDocs uses
17-
a YAML configuration file and can optionally use themes to easy change the
18-
look-and-feel of the documentation output.
12+
([source code](https://github.com/mkdocs/mkdocs/))
13+
is a static site generator that combines Markdown content with
14+
[Jinja2 templates](/jinja2.html) to produce websites.
15+
MkDocs can be pronounced "McDocs" or "M-K Docs",
16+
[although the core committers do not have a strong preference](https://twitter.com/_tomchristie/status/805861272076042241)
17+
one way or the other on the name's pronunciation.
1918

2019
<a href="http://www.mkdocs.org/" style="border: none;"><img src="/img/mkdocs-logo.jpg" width="100%" alt="MkDocs static site and documentation generator logo." class="technical-diagram" style="border-radius:5px"></a>
2120

2221

2322
## What's great about MkDocs?
24-
MkDocs has three great features for a static site generator:
25-
26-
1. search
27-
1. easy configuration
28-
1. drop-in themes
29-
23+
MkDocs uses a YAML configuration file and can optionally use themes to
24+
easy change the look-and-feel of the documentation output.
25+
26+
In addition to the easy configuration via a YAML file and the drop-in
27+
themes, MkDocs also has a wonderful search feature. Search is often not
28+
possible out of the box in other static site generators. With MkDocs search
29+
can easily be added without plugins or code changes to the static site
30+
generator.
3031

3132
<div class="well see-also">MkDocs is an implementation of the <a href="/static-site-generator.html">static site generators</a> concept. Learn how the parts fit together in the <a href="/web-development.html">web development</a> chapter or view <a href="/table-of-contents.html">all topics</a>.</div>
3233

0 commit comments

Comments
 (0)