Update examples in docs and bump version to 24.10

Author: wigging

docs/example.rst

@@ -0,0 +1,42 @@
+Examples
+========
+
+Examples are available on `GitHub <https://github.com/wigging/genja>`_ in the Genja repository. See the sections below for more information about each example.
+
+Directory website
+-----------------
+
+The ``directory-website`` example uses the ``website`` directory for the generated output. The ``_mdcontent`` directory contains the Markdown files used by Genja to generate the HTML files. The ``_templates`` directory contains the Jinja2 templates.
+
+Use the commands shown below to build the website and run a local server to view the website in the default web browser. The website will automatically reload in the web browser when changes are saved to the Markdown files.
+
+.. code:: text
+
+   cd examples/directory-website
+   genja serve
+
+Use the commands shown below to build the example website without starting a local server.
+
+.. code:: text
+
+   cd examples/directory-website
+   genja build
+
+Top-level output
+----------------
+
+The ``toplevel-output`` example uses the top-level directory for the generated output. The ``_notes`` directory contains the Markdown files used by Genja to generate the HTML files. The ``_templates`` directory contains the Jinja2 templates.
+
+Use the commands shown below to build the website and run a local server to view the website in the default web browser. The website will automatically reload in the web browser when changes are saved to the Markdown files.
+
+.. code:: text
+
+   cd examples/toplevel-output
+   genja serve
+
+Use the commands shown below to build the example website without starting a local server.
+
+.. code:: text
+
+   cd examples/toplevel-output
+   genja build

docs/examples.rst

@@ -28,25 +28,24 @@ Check the installed version from the command line:
 Usage
 -----
 
-Before running genja, create a project structure as shown below. The **content** directory contains Markdown files that are used to generate HTML files. The **templates** directory contains `Jinja <https://jinja.palletsprojects.com>`_ templates that are used to render the HTML pages. The **docs** directory contains the built website which can be hosted with GitHub Pages. Lastly, the **config.json** defines the URLs and directories for the project.
+Before running genja, create a project structure as shown below. The **content** directory contains Markdown files that are used to generate HTML files. The **templates** directory contains `Jinja <https://jinja.palletsprojects.com>`_ templates that are used to render the HTML pages. The **docs** directory contains the built website which can be hosted with GitHub Pages. Lastly, the **config.toml** defines the URLs and directories for the project.
 
 .. code:: text
 
    myproject/
    ├── content/
    ├── templates/
    ├── docs/
-   └── config.json
+   └── config.toml
 
-The items in the **config.json** are shown below. The ``base_url`` is the URL for the homepage of the website. Markdown files that are parsed by Genja are located in the ``input_dir`` directory. The HTML files generated from Genja are located in the ``output_dir`` directory. Static content such as images and CSS files should go in the output directory.
+The items in the **config.toml** are shown below. The ``base_url`` is the URL for the homepage of the website. Markdown files that are parsed by Genja are located in the ``markdown_dir`` directory. The Jinja2 templates used by Genja are located in the ``template_dir`` directory The HTML files generated from Genja are located in the ``output_dir`` directory. Static content such as images and CSS files should go in the output directory.
 
-.. code:: json
+.. code:: toml
 
-   {
-       "base_url": "https://example.com/mywebsite",
-       "input_dir": "content",
-       "output_dir": "docs"
-   }
+   base_url = "https://example.com/mywebsite"
+   markdown_dir = "content"
+   template_dir = "templates"
+   output_dir = "docs"
 
 Use the ``serve`` command to build the website and start a local server. This will automatically open the default web browser to view the website. The website will automatically reload when changes are saved to the Markdown files.
 

docs/getstarted.rst

@@ -1,18 +1,11 @@
-Genja documentation
+Genja Documentation
 ===================
 
-Genja is a simple static site generator for GitHub Pages. It is a command line tool built in Python that generates HTML files and a JSON feed from Markdown content.
+Genja is a simple static website generator for GitHub Pages. It is a command line tool built in Python that generates HTML files and a JSON feed from Markdown content.
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
    getstarted
-   example
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+   examples

docs/index.rst

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "genja"
-version = "24.3"
+version = "24.10"
 authors = [{name = "Gavin Wiggins"}]
 description = "Static site generator for GitHub Pages"
 readme = "README.md"