Skip to content

James231/Documentation-Templater

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
Jun 5, 2020
Jun 5, 2020
Jun 25, 2020

Documentation Templater V2

Codacy Badge

Templating engine for quickly and easily creating static web-based documentation projects. Write short and readable HTML or Markdown code containing only the important information for each page. All styling and layouts are defined in templates which can be changed to give you the full capabilities of pure HTML should you need it.

Included templates generate a clean, responsive, mobile-compatible documentation which you can view here.

The tool is cross-platform written using .NET Core 3.1.

Features:

  • Write short documentation pages in Html or Markdown
  • Supports all the common markdown features. Add more by installing Markdig extensions
  • Create custom controls like <card property="value">...</card> similar to JS Frameworks like Anuglar and React
  • Comes with a modern and responsive example template
  • Sidebar navigation supported
  • Minifies output HTML, CSS and JavaScript for fast load times
  • Output is ready to copy into a public folder for hosting
  • Output is static so free hosting is availalbe on GitHub Pages, GitLab Pages or Netlify
  • Very fast documentation build times which increase linearly with the number of pages

YouTube Tutorials

See the First Video Tutorial on YouTube

I am working on a series of 3 YouTube tutorials:

Using the Tool

To use the tool, download the latest version through GitHub Releases. There are downloads for Windows, Mac and Linux, both including a bundled .NET Core 3.1 runtime, or without if you already have it installed.

See the Wiki for a full guide.

Building from Source

To build from source you need the latest .NET Core 3 SDK. For Windows users just install the latest verion of Visual Studio 2019 with the .NET Core workload . Use the following publish command to get a single file executable:

dotnet publish -r win10-x64 -c Release -p:PublishSingleFile=true

where you change win10-x64 to your platform.

There is a more detailed guide to building from source in the Wiki.

License

This code is released under MIT license. Modify, distribute, sell, fork, and use this as much as you like. Both for personal and commercial use. I hold no responsibility if anything goes wrong.

If you use this, you don't need to refer to this repo, or give me any kind of credit but it would be appreciated. At least a would be nice.

Contributing

Pull requests of any form are welcome. See the Wiki for contribution suggestions.

Support

You can contact me by submitting a contact form here or by opening an issue.

About

Cross-platform Templating Engine for Quickly and Easily Creating Static Web-Based Documentation Projects in HTML and Markdown.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages