8000 GitHub - SparkInnovationsCorp/iDocsMarkdown: iDocsMarkdown is a robust tool for dynamically converting Markdown files into beautifully formatted HTML documentation web site. It supports advanced Markdown features, extracts and uses metadata for SEO, and automatically generates structured navigation for easy content access, making it perfect for developers and technical writers.
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

iDocsMarkdown is a robust tool for dynamically converting Markdown files into beautifully formatted HTML documentation web site. It supports advanced Markdown features, extracts and uses metadata for SEO, and automatically generates structured navigation for easy content access, making it perfect for developers and technical writers.

License

Notifications You must be signed in to change notification settings

SparkInnovationsCorp/iDocsMarkdown

 
 

Repository files navigation

iDocsMarkdown

iDocsMarkdown is a dynamic, multi-page documentation engine built using the iDocs template and enhanced with a robust backend using ASP.NET Core. This powerful tool leverages Bootstrap 4, Markdig for Markdown processing, and HtmlAgilityPack for HTML parsing, enabling you to create comprehensive navigatable online documentation for technical documentation, books, or whatever your heart desires. And its fully compatable with OpenAI's ChatGPT copied output. You are welcome! Project is ASP.NET 6.0 Core MVC. Build with Visual Studios 2022.

What It Does

Essentially, this application operates on a directory of Markdown files, structured like this:

Markdown Code

It then dynamically generates a beautifully navigable website, perfect for documentation purposes:

Dynamic HTML Display

How to Use

Download, compile and publish under Visual Studios 2022 into IIS or compatable web host. Then simply update the MD docs in the MD folder.

Bugs and Issues

Have an issue with this engine? Open a new issue here

OR email me at support@sparkinnovationscorp.com.

Credits

Created By

Jason Bramble with Spark Innovations Corp

##Kudos to the Original Author A huge kudos and heartfelt thanks to Harnish Design for creating the original iDocs template. Their work laid the foundation for this enhanced documentation engine, making it possible to create beautifully structured and easy-to-navigate documentation.

Donations & Support

I dont need anything. Just enjoy the free app!

To-Do List

  1. Implement Caching for Enhanced Performance
    Plan to integrate caching mechanisms based on markdown file modification dates to significantly boost performance and reduce load times.

  2. Expand Theme Support
    Aim to include support for various other iDocs theme versions, providing users with more flexibility and customization options for their documentation needs.

License

See the LICENSE file for license rights and limitations (MIT). Additionally, Jason Bramble with Spark Innovations Corp grants the same rights for the application and code under the MIT License:

About

iDocsMarkdown is a robust tool for dynamically converting Markdown files into beautifully formatted HTML documentation web site. It supports advanced Markdown features, extracts and uses metadata for SEO, and automatically generates structured navigation for easy content access, making it perfect for developers and technical writers.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • SCSS 69.6%
  • CSS 24.6%
  • C# 2.5%
  • HTML 2.3%
  • JavaScript 1.0%
0