https://github.com/piranhacms/piranha.core.docs

Official documentation for Piranha CMS
https://github.com/piranhacms/piranha.core.docs

aspnet-core cms cms-framework documentation dotnet dotnet-core markdown

Last synced: 11 days ago
JSON representation

Official documentation for Piranha CMS

• Host: GitHub
• URL: https://github.com/piranhacms/piranha.core.docs
• Owner: PiranhaCMS
• License: mit
• Created: 2019-10-13T10:04:53.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-22T06:04:08.000Z (26 days ago)
• Last Synced: 2024-10-23T08:27:33.591Z (24 days ago)
• Topics: aspnet-core, cms, cms-framework, documentation, dotnet, dotnet-core, markdown
• Size: 7.16 MB
• Stars: 12
• Watchers: 5
• Forks: 51
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Welcome to the Piranha Docs

This documentation is designed to be presented on the official [piranhacms.org](http://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](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](http://contributor-covenant.org/) to clarify expected behavior in our community.

For more information see the [.NET Foundation Code of Conduct](http://www.dotnetfoundation.org/code-of-conduct).

## .NET Foundation

This project is supported by the [.NET Foundation](http://www.dotnetfoundation.org).