Skip to content

Latest commit

 

History

History
21 lines (13 loc) · 1.23 KB

README.md

File metadata and controls

21 lines (13 loc) · 1.23 KB

Welcome to the Piranha Docs

This documentation is designed to be presented on the official piranhacms.org website. In order to do so we're using a small Module we've created called Statica that converts a hierarchical markdown structure into a partial sitemap which can be used in a Piranha site. You can find the source code for this module here:

https://github.com/tidyui/statica

For everything to work as smooth as possible you need to follow the syntax of this tool, which is fairly simple:

  • All files or folders must exactly follow the syntax xx. Title, where xx is the sort order of the item.
  • All files must be in markdown .md.
  • Folder pages that should also have content must include a Index.md.
  • All assets (images etc) must be stored in the _assets folder.

Code of Conduct

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information see the .NET Foundation Code of Conduct.

.NET Foundation

This project is supported by the .NET Foundation.