Skip to content

Commit 586d9db

Browse files
committed
More resources
1 parent 817a3e6 commit 586d9db

3 files changed

Lines changed: 17 additions & 3 deletions

File tree

_learn/01-sphinx-python-rtd.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ image:
66
caption: "Screenshot from Read the Docs theme"
77
---
88

9-
There are two major versions of Python active today, Python 2 and Python 3. Sphinx works with either version. Python 3 is the current and recommended version, however many scripts and programs were written in Python 2 and have yet to be upgraded.
9+
Sphinx works with either major versions of Python active today, Python 2 and Python 3. Python 3 is the current and recommended version. Sphinx is a documentation tool that creates HTML, CSS, and JavaScript files from [ReStructured](http://docutils.sourceforge.net/rst.html) text files.
1010

11-
Mac OS includes a version of Python 2 by default, but it is NOT the latest version of Python 2. Install the latest version of Python 2 using `homebrew`, a package manager on Mac.
11+
In case you need both versions, this tutorial walks through both on a Mac. Refer to the [Downloads on the Python site](https://www.python.org/downloads/windows/) for Windows.
1212

1313
#### Installing Python 2.7.x on Mac
1414

@@ -110,6 +110,8 @@ Most people use Virtual Environments because it's a recommended practice when wo
110110
111111
## Create a Basic Sphinx Project
112112
113+
You can also get familiar with [ReStructured text](http://docutils.sourceforge.net/docs/user/rst/quickstart.html), a plain text markup syntax system that you use to write content in Sphinx documentation. Sphinx can also accept [Markdown](https://commonmark.org/help/) files.
114+
113115
1. Create a new directory for your project:
114116
```
115117
(py3-sphinx) $ mkdir do-docs-as-code
@@ -151,3 +153,8 @@ Most people use Virtual Environments because it's a recommended practice when wo
151153
```
152154
1. In your browser, refresh the `build/html/index.html` page to see the new Contents with two entries linked.
153155
1. Make sure you commit your changes to the Git repository by following the steps in "Working with content in GitHub repositories."
156+
157+
## Additional resources
158+
159+
[Sphinx Python Documentation Generator](http://www.sphinx-doc.org/en/stable/)
160+
[ReStructured text documentation](http://docutils.sourceforge.net/rst.html)

_learn/02-jekyll-ruby-gh-pages.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ image:
66
caption: "Screenshot using Minimal Mistakes theme"
77
---
88

9-
To prepare your environment to build Jekyll sites locally, follow the instructions for either Windows or MacOS.
9+
Jekyll is a Static Site Generator that typically accepts [Markdown](http://commonmark.org/help/) for authoring. [Jekyll](https://jekyllrb.com/) has its own documentation site and a [Quickstart](https://jekyllrb.com/docs/). To prepare your environment to build Jekyll sites locally, follow the instructions for either Windows or MacOS.
1010

1111
## Set up Ruby and Jekyll on Windows with Docker
1212

@@ -172,6 +172,8 @@ Once you've prepared your environment, you can build locally and review the site
172172
> Leave the serve terminal open and running. Every time you save changes to a file, it automatically regenerates the site so you can test the output as you write. That said, if you change the `_config.yml` file, you must stop (ctrl-c) and then re-run the serve command to see changes.
173173
174174
# Additional resources
175+
176+
[Markdown reference](http://commonmark.org/help/)
175177
[Documentation Theme for Jekyll](https://idratherbewriting.com/documentation-theme-jekyll/)
176178
[Lynda.com Web foundations, GitHub Pages](https://www.lynda.com/Web-Development-tutorials/GitHub-pages/609031/654613-4.html)
177179
[Jekyll documentation about GitHub Pages](https://jekyllrb.com/docs/github-pages/)

_learn/03-hugo-go-netlify.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,3 +123,8 @@ themeVariant = "green"
123123
[outputs]
124124
home = [ "HTML", "RSS", "JSON"]
125125
```
126+
127+
## Additional resources
128+
129+
[Hugo Quickstart](https://gohugo.io/getting-started/quick-start/)
130+
[Hugo Themes web site](https://themes.gohugo.io/)

0 commit comments

Comments
 (0)