Skip to content

Latest commit

 

History

History
114 lines (87 loc) · 3.51 KB

README.md

File metadata and controls

114 lines (87 loc) · 3.51 KB
Raw

MarkSite - An ASP.NET based Markdown CMS

A great system for:

  • Community driven documentation
  • A personal website
  • Company website with multiple contributors

Build status

Deploy to Azure

Live demo: vwd.azurewebsites.net

Features

  • Uses CommonMark for rendering Markdown
  • Uses the folder structure to create the menu
  • Convension based file/folder structure
  • Each page has a link to Edit this page on GitHub
  • Everything is configurable from web.config
  • Semantic URLs
  • Each .md file can contain configuration
  • AppVeyor integration
    • Automatically validates any pull request
    • Checks for missing metadata
  • Theming support
  • Support for IE9 and all modern browsers
  • Responsive design to support all device types
  • Best-in-class performance (Page Speed, YSlow)
  • Best-in-class accessibility (WGAC, Section 508)
  • Search engine optimization
    • HTML 5 microdata
    • robots.txt
    • Sitemap.xml
    • Semantic markup
  • Social integration
    • Twitter cards support
    • OpenGraph support
    • Pinterest support
  • Environment integration
    • IE9+ pinned sites suppport
    • Windows live tile support
    • iOS icon support
    • Android icon support
    • Firefox web manifest support

Getting started

The website itself is really simple. It only consist of a single index.cshtml file. The entire site is built up around Markdown (.md) files located inside the pages directory by default.

Folder structure

The folder structure determines how the menu is constructed as well as the URLs to each page.

Folder structure

Each folder MUST have a file called index.md with the exception of folders starting with an underscore (example: /pages/_images/).

Metadata

Each .md file has a bit of metadata at the top that allows you to customize various aspects of the file.

<properties
	pageTitle="FTP"
	description="bla bla bla"
	slug="ftp"
    order="300"
	keywords="ftp, deploy"
/>

My markdown content goes here
  • pageTitle: The title of each page. Required
  • description: The description of each page. Required
  • slug: A Slug is what the URL should be. Must be lower cased. Required
  • order: Determins the sort order of the page in the menu. Optional
  • keywords: A comma separated list of keywords. 3 or more required

Screenshots/animated GIFs

To maintain a consistent look to all the screenshots/animated GIFs, please adhere to these Visual Studio settings:

Font: 12pt Consolas
Theme: Light

Also, please make sure to have a ~5 pixel padding when making an animated GIF from one of the editors, so the things you show aren't located all the way at the edges of the image, but about 5 pixels from the top and left.

The padding rule only applies to screenshots/animated GIFs taken inside the editors.

The width of any screenshot/animated GIF, make sure to keep them at a maximum of 600 pixels wide.

Validation

To help make sure that each pull request meets the requirements of the metadata, the validator helps guide the contributors to write valid .md files for the MarkSite instance.

When using AppVeyor, each pull requests is automatically being build and the validator will automatically fail the build in case the pull request isn't satisfying the validator.