{"id":16494457,"url":"https://github.com/james231/documentation-templater","last_synced_at":"2025-03-23T12:34:59.466Z","repository":{"id":38706299,"uuid":"151067949","full_name":"James231/Documentation-Templater","owner":"James231","description":"Cross-platform Templating Engine for Quickly and Easily Creating Static Web-Based Documentation Projects in HTML and Markdown.","archived":false,"fork":false,"pushed_at":"2020-06-25T13:15:41.000Z","size":30091,"stargazers_count":20,"open_issues_count":1,"forks_count":9,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-02T00:51:24.723Z","etag":null,"topics":["cross-platform","documentation","documentation-generator","documentation-template","documentation-tool","dotnet-core","html","markdown","templating-engine"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/James231.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-10-01T09:58:35.000Z","updated_at":"2025-01-05T14:06:44.000Z","dependencies_parsed_at":"2022-07-10T22:16:09.584Z","dependency_job_id":null,"html_url":"https://github.com/James231/Documentation-Templater","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/James231%2FDocumentation-Templater","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/James231%2FDocumentation-Templater/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/James231%2FDocumentation-Templater/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/James231%2FDocumentation-Templater/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/James231","download_url":"https://codeload.github.com/James231/Documentation-Templater/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244301660,"owners_count":20430990,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cross-platform","documentation","documentation-generator","documentation-template","documentation-tool","dotnet-core","html","markdown","templating-engine"],"created_at":"2024-10-11T14:13:43.583Z","updated_at":"2025-03-23T12:34:54.965Z","avatar_url":"https://github.com/James231.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Documentation Templater V2\n\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/87bea31db9ff49609bf01043525fb510)](https://www.codacy.com/manual/James231/Documentation-Templater?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=James231/Documentation-Templater\u0026amp;utm_campaign=Badge_Grade)\n\nTemplating 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.\n\nIncluded templates generate a clean, responsive, mobile-compatible documentation [which you can view here](https://documentation-templater-sample.jam-es.com/).\n\nThe tool is cross-platform written using .NET Core 3.1.\n\nFeatures:\n*   Write short documentation pages in Html or Markdown\n*   Supports all the common markdown features. Add more by installing [Markdig](https://github.com/lunet-io/markdig) extensions\n*   Create custom controls like `\u003ccard property=\"value\"\u003e...\u003c/card\u003e` similar to JS Frameworks like Anuglar and React\n*   Comes with a modern and responsive example template\n*   Sidebar navigation supported\n*   Minifies output HTML, CSS and JavaScript for fast load times\n*   Output is ready to copy into a public folder for hosting\n*   Output is static so free hosting is availalbe on [GitHub Pages](https://pages.github.com/), [GitLab Pages](https://about.gitlab.com/stages-devops-lifecycle/pages/) or [Netlify](https://www.netlify.com/)\n*   Very fast documentation build times which increase linearly with the number of pages\n\n## YouTube Tutorials\n\n[\u003cimg width=\"480\" height=\"270\" alt=\"See the First Video Tutorial on YouTube\" src=\"https://cdn.jam-es.com/img/documentation_templater_video_thumbnail_playable.png\" target=\"_blank\"/\u003e](https://www.youtube.com/watch?v=wbwIauMc43Y)\n\nI am working on a series of 3 YouTube tutorials:  \n- [Part 1: Downloading, Setting Up, and how to Write Content](https://www.youtube.com/watch?v=wbwIauMc43Y)\n- Part 2: Changing styles/layouts or writing your own template from scratch - COMING SOON  \n- Part 3: Get your documentation online for free with GitLab Pages - COMING SOON  \n\n## Using the Tool\n\nTo use the tool, download the latest version through [GitHub Releases](https://github.com/James231/documentation-templater/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.\n\n[See the Wiki for a full guide.](https://github.com/James231/Documentation-Templater/wiki)\n\n## Building from Source\n\nTo 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:\n```C#\ndotnet publish -r win10-x64 -c Release -p:PublishSingleFile=true\n```\nwhere you change `win10-x64` to your platform.\n\nThere is a more detailed [guide to building from source in the Wiki](https://github.com/James231/Documentation-Templater/wiki/10.-Building-From-Source).\n\n## License\n\nThis 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.\n\nIf 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 :star: would be nice.\n\n## Contributing\n\nPull requests of any form are welcome. See the [Wiki for contribution suggestions](https://github.com/James231/Documentation-Templater/wiki/11.-Welcome-Contributions).\n\n## Support\n\nYou can contact me by submitting a contact form [here](https://jam-es.com) or by opening an issue.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjames231%2Fdocumentation-templater","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjames231%2Fdocumentation-templater","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjames231%2Fdocumentation-templater/lists"}