Skip to content

Commit

Permalink
The HTML frontmatter docs are their own thing now
Browse files Browse the repository at this point in the history
  • Loading branch information
zeke committed Oct 2, 2014
1 parent 4125a3b commit 8336390
Showing 1 changed file with 2 additions and 27 deletions.
29 changes: 2 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,37 +35,12 @@ The copied and generated files are [ignored](/.gitignore) for two reasons:

## HTML Frontmatter

When the build process runs, it looks for metadata in markdown files in the following format:

```html
<!--
title: GitHub integration
keywords: github, git, enterprise
description: If your organization uses GitHub or GitHub Enterprise, npmE can be configured
to automatically use them for login and access control.
-->
```

See an example in [content/enterprise/github.md](/content/enterprise/github.md).

This metadata is then added to [content.json](/content.json), and looks like this:
Read all about it on the [html-frontmatter](https://www.npmjs.org/package/html-frontmatter) README.

```json
{
"title": "GitHub integration",
"keywords": "github, git, enterprise",
"description": "If your organization...etc"
}
```

If the file has a `title` property in its frontmatter, it will be used for
If a file has a `title` property in its frontmatter, it will be used for
the `<title>` of the rendered HTML page. If `title` is absent from the
frontmatter, the filename (without the .md extension) is used.

Frontmatter values can span multiple lines for longer strings like
description text. To make a value multiline, simply indent it with two or
more spaces on subsequent lines.

## Webservice

The [content.json](/content.json) file is served publicly at `/content.json`
Expand Down

0 comments on commit 8336390

Please sign in to comment.