Skip to content

Commit 6baa895

Browse files
committed
Adds three more to learn series
1 parent 47abd10 commit 6baa895

10 files changed

Lines changed: 11 additions & 11 deletions
Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: "Evaluating Static Site Generator themes"
33
image:
4-
path: /images/so-simple-sample-image-4.jpg
5-
thumbnail: /images/site-logo.png
4+
path: /images/learn/ssg-themes.png
5+
thumbnail: /images/learn/ssg-themes400x225.png
66
---
77

88
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. 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.
@@ -16,7 +16,7 @@ Are there designs for output of levels of admonition, such as warning, informati
1616
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?
1717

1818
## Comment engines
19-
Which comment engines are supported and do they work with what other organizations use in your company or group?
19+
Which comment engines are supported? Do they work with what other organizations use in your company or group?
2020

2121
## Customization
2222
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.
@@ -28,7 +28,7 @@ Are images automatically resized when looking at them on a mobile browser or res
2828
When translations are available, are they simple to get to? Does the theme itself have the ability to be localized, such as for the search form or navigation elements, can the labels used in the theme be localized?
2929

3030
## Navigation and configuration possibilities
31-
Does the theme have a sidebar, breadcrumbs, and an in-page table of contents? 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?
31+
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?
3232

3333
## Responsive and mobile design
3434
Does the theme use thoughtful navigation and search when on a small screen?
@@ -37,12 +37,12 @@ Does the theme use thoughtful navigation and search when on a small screen?
3737
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?
3838

3939
## Social media support
40-
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 documentation page?
40+
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?
4141

4242
## Tables
4343
Do tables work on different browsers? If PDF or epub is another output option, do the tables still work on a particular page size or do you need to adjust how tables are made in the source file itself for good results in the output?
4444

45-
## Theme Updates
45+
## Theme updates
4646
How easy is it to upgrade the theme files? Can you make regular updates through a version-control system and know exactly which theme you have in use?
4747

4848
## Versions
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: "Evaluating table layouts and formatting"
33
image:
4-
path: /images/so-simple-sample-image-4.jpg
5-
thumbnail: /images/site-logo.png
4+
path: /images/learn/table-layout.jpg
5+
thumbnail: /images/table-layout400x225.png
66
---
77

88
One of the most helpful tools when creating tables for Markdown or RST is the Tables Generator at https://www.tablesgenerator.com/markdown_tables. You can draw tables or paste table data and then render the ASCII-based output for pasting into your document source file.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: "Static Site Generator search options"
33
image:
4-
path: /images/so-simple-sample-image-4.jpg
5-
thumbnail: /images/site-logo.png
4+
path: /images/learn/ssg-search-options.png
5+
thumbnail: /images/ssg-search-options400x225.png
66
---
77

88
Most static site generators provide a browser-side search capability, where the list of indexed keywords for search are built at the same time as the output. Learn more about considerations for each SSG in the following sections.

_posts/00-github-for-docs-files.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Learning GitHub or any source control system backed by `git` for documentation s
1212

1313
You can learn how to sign up for a GitHub account and pricing plans on [help.github.com](https://help.github.com/articles/signing-up-for-a-new-github-account/).
1414

15-
You can do all these docs-as-code tutorials with a free GitHub account.
15+
You can do all these docs-as-code tutorials with a free GitHub account. I recommend using SSH keys rather than entering your password for each `git` command that requires authentication. Read about [Connecting to GitHub with SSH](https://help.github.com/articles/connecting-to-github-with-ssh/) in the GitHub user documentation.
1616

1717
## Learn basic Terminal and Git Bash commands
1818

227 KB
Loading
78.6 KB
Loading

images/learn/ssg-themes.png

27.7 KB
Loading

images/learn/ssg-themes400x225.png

23 KB
Loading

images/learn/table-layout.png

9.7 KB
Loading
10.6 KB
Loading

0 commit comments

Comments
 (0)