You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _learn/07-evaluating-ssg-themes.md
+16-6Lines changed: 16 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,20 +6,24 @@ image:
6
6
thumbnail: /images/learn/ssg-themes400x225.png
7
7
---
8
8
9
-
Themes for static site generators often provide the advanced user experience features such as search. You also analyze the theme to make decisions on the authoring side, such as a table format for large data tables.
9
+
Themes for static site generators often provide the advanced user experience features such as navigation, search, and responsive designs for mobile consumption. You also analyze the theme to make decisions on the authoring side, such as a table format for large data tables.
10
10
11
-
What about printed outputs, such as PDF? Or versions for the output and the source? Any performance gains you can make with the builds themselves? Themes are one part of this analysis.
11
+
When researching and selecting a theme, analyze the possibilities for printed outputs, such as PDF or EPUB. Perhaps you need version control for both the output and the source files. The size of your site may mean you need to consider performance gains you can make with the build. Themes are one part of this analysis.
12
12
13
13
Here's a short list of questions you may want to ask about the theme you use for a static site generator.
14
14
15
15
## Admonitions or notes
16
16
Are there designs for output of levels of admonition, such as warning, information, and note?
17
17
18
+
Advanced admonitions can enable substituting custom text instead of "Note" or "Warning," or custom icons. You can also configure the admonitions in some themes to expand or contract in-page. For example, look at the variations for Markdown source with the [Mkdocs Material theme when using the admonition extension](https://squidfunk.github.io/mkdocs-material/extensions/admonition/). Or, when using [RST with the Read the Docs theme, you have lots of directives](https://sphinx-rtd-theme.readthedocs.io/en/latest/demo/demo.html#admonitions) to choose from, including Attention, Hint, Important, Note, Tip, Error, or Danger, or write your own. You should also test if code blocks work within an admonition if that is important in your documentation.
For code examples, can you set the exact highlight you want to use, such as JavaScript or Python or Bash? Does the code snippet have a copy icon for copying only the code and not copying a prompt?
23
+
For code examples, can you set the exact highlight you want to use, such as JavaScript or Python or Bash? Does the code snippet have a copy icon for copying only the code and not copying a prompt? What about the behavior of the scroll bar for long lines of code examples? Are there line numbers available? Can you highlight or emphasize certain lines to convey meaning? How about captions on the code block, similar to captions on figures?
20
24
21
-
## Comment engines
22
-
Which comment engines are supported? Do they work with what other organizations use in your company or group?
25
+
## Comments or forums integration
26
+
Which comment engines are supported? Do they work with the comment systems other organizations use in your company or group?
23
27
24
28
## Customization
25
29
How straightforward is it to add your logo or a header that's common to multiple web sites? Can you learn how to maintain the theme's customizations yourself or will you need to rely on a web developer for maintenance and any enhancements such as adding a version drop-down list? For example, the Jekyll theme "Minimal Mistakes" is "skinnable," meaning you can [configure various color variations](https://mmistakes.github.io/minimal-mistakes/docs/configuration/) for that theme.
@@ -33,11 +37,17 @@ When translations are available, are they simple to get to? Does the theme itsel
33
37
## Navigation and configuration possibilities
34
38
Does the theme have a sidebar, breadcrumbs, and an in-page table of contents available? Can you turn on or off each based on the page layout or page template or whether the person is using a mobile browser or tablet?
35
39
40
+
Do you want to have Previous and Next buttons on each page, so that someone can go through a series of pages in order?
41
+
36
42
## Responsive and mobile design
37
43
Does the theme use thoughtful navigation and search when on a small screen?
38
44
45
+
Can your readers get to the Contents fairly easily and expand and contract, even when on a mobile phone or tablet? Check how the search experience works when using a smaller screen. Most of the built-into-the-browser developer tool kits, such as the Chrome Developer Tool, lets you preview the site experience on a simulated smaller screen.
46
+
47
+

48
+
39
49
## Search
40
-
Is the search form in a prominent location and if needed, can you move the search form on the page? Does the search work on mobile devices with readable results? Can the result list also be styled?
50
+
Is the search form in a prominent location and if needed, can you customize the them to place the search form somewhere else on the page? Does the search work on mobile devices with readable results? Can the result list also be styled?
41
51
42
52
## Social media support
43
53
If you want Twitter cards for your documentation pages, are they available through the theme? Which social media sites can you link to from each page?
Copy file name to clipboardExpand all lines: book/index.md
+9-7Lines changed: 9 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,18 +5,20 @@ excerpt: "Docs Like Code book in print and ebook. Paperback now available on Ama
5
5
last_modified_at: Sat May 13 08:43:14 CDT 2017
6
6
---
7
7
8
-
<imgsrc="../../images/docs-like-code-book.jpg"alt="Docs Like Code"style="padding:14px;"align="right"height="200"width="319">
9
8
10
-
<h1>About the book</h1>
9
+
<h1>Get Started with Docs as Code</h1>
10
+
11
+
<imgsrc="../../images/docs-like-code-book.jpg"alt="Docs Like Code"style="padding:14px;"align="right"height="200"width="319">
11
12
<p>We've transformed the way teams work together on docs, and we want to show you the best practices for writing docs using development tools and techniques. Now available in both print and ebook, check out <i>Docs Like Code</i>.</p>
@@ -68,9 +70,9 @@ last_modified_at: Sat May 13 08:43:14 CDT 2017
68
70
margin-bottom: 20px;
69
71
padding: 8px 20px;
70
72
font-size: 14px;
71
-
background-color: #ffc858;
73
+
background-color: #fc5720;
72
74
color: #fff;
73
-
border: 2px solid #ffc858 !important;
75
+
border: 2px solid #fc5720 !important;
74
76
border-radius: 3px;
75
77
&:visited {
76
78
color: #fff;
@@ -92,6 +94,6 @@ last_modified_at: Sat May 13 08:43:14 CDT 2017
92
94
<blockquoteclass="twitter-tweet"data-lang="en"><plang="en"dir="ltr">This one just moved to the top of my reading list. A book on how to treat docs like code by <ahref="https://twitter.com/annegentle">@annegentle</a>. Awesome! > <ahref="https://t.co/nRkSZkhv5x">https://t.co/nRkSZkhv5x</a></p>— Patrick Andriessen (@napnamPat) <ahref="https://twitter.com/napnamPat/status/838695213841403904">March 6, 2017</a></blockquote>
0 commit comments