Documentation Sample

Pages

  • Contents
  • Pages
  • HTML Page
  • Markdown Page
  • Templates
  • Example Pages
    • Typography
    • Tables
    • Code Blocks
    • Blockquotes
    • Other Markdown Features
    • More Pages
      • Hosting
      • Code Minifiers
      • Build Times
      • Even More Pages
        • And More
          • Blank Page 1
          • Blank Page 2
          • Blank Page 3
          • Blank Page 4
          • Blank Page 5
          • Blank Page 6
          • Blank Page 7
          • Blank Page 8
          • Blank Page 9
          • Blank Page 10
        • Blank Page 1
        • Blank Page 2
        • Blank Page 3
        • Blank Page 4
        • Blank Page 5
        • Blank Page 6
        • Blank Page 7
        • Blank Page 8
        • Blank Page 9
        • Blank Page 10
      • And More
        • Blank Page 1
        • Blank Page 2
        • Blank Page 3
        • Blank Page 4
        • Blank Page 5
        • Blank Page 6
        • Blank Page 7
        • Blank Page 8
        • Blank Page 9
        • Blank Page 10
  • Page Orders

Pages

Author: Jam-Es.com    -    Updated: 2nd June 2020    -    2 minutes to read

To use the Documentation Templater Tool, you simply provide it with a list of pages for your site. Each page is represented by a Markdown or Html file. Your pages should only contain very basic page content.

The tool then converts your code into pure Html which it inserts into a template Page. The template contains code for styles and layouts. You can also create your own templates to add your own 'controls' which is great for avoiding duplicating code. Templates keep your page files short and simple, while allowing you to customize the full code for your documentation website should you need to.

Project Structure

The basic folder structure for a Documentation Templater project looks like this:

. Root Folder
├── Input
|  ├── page1.html
|  ├── page2.md
|  └── Page Subdirectory
|     └── page3.html
├── Output
|  ├── page1.html
|  ├── page2.html
|  └── page+subdirectory
|     └── page3.html
├── Template
|  └── ...
└── DocumentationTemplater.exe

You create your Html and Markdown pages inside the Input folder. Run the DocumentationTemplater.exe then see the results in the Output folder. The contents of Output folder can be copied directly to your web hosts public folder to be served. Simple.

Note: The subdirectories in the Input folder are what give the subfolder structure in the sidenav. Although the sidenav is just one example of how the folder structure can be used, and you can achieve many more using templates.

© Copyright 2020, My Company.