# Jade
Jade is a markdown renderer for Flask applications.
Initialise a new Jade project after installing with `python -m jade init`. This will create a simple Flask site with a home page, and a small blog, as an example of how to use the framework.
To get started, try editing the `content/home.md` file.
At the top of this file, you will see some `frontmatter`. This is `yaml` formatted content that is passed to the builder, and the template.
While not required, the following `frontmatter` is recommended for each of your pages.
* `permalink` - Where on the site you want the page to register. Defaults to the file's path within the `content` directory, without the file extension.
* `template` - the name of the template in your `templates` directory to render the content into. Defaults to `default`.
## Reserved names
* `page` - You can access the page frontmatter in your templates through the `page` variable. For example, the title for this page would be accessed with `page.title`.
* `pages` - The `pages` variable contains all subdirectories of the `content` directory. This can be useful for things such as rendering a blog home page, with a link to each post in a directory. Note that nested directories are not currently supported.
* `site` - You can also access site parameters, such as the site name through the `site` variable in all of your templates. Any parameters that you need globally should be added to the `.jade-config.yaml` file, under the site key. Try updating the `name` key under `site` in the config file.
## Contribution
Install development requirements with `pip install -r requirements-dev.txt`, then install `pre-commit` with `pre-commit install`. Ensure all `nox` tests are passing before creating a pull request.
Raw data
{
"_id": null,
"home_page": "https://github.com/sam-kenney/jade",
"name": "jade-md",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Sam Kenney",
"author_email": "sam.kenney@me.com",
"download_url": "https://files.pythonhosted.org/packages/53/fd/54e04a88ba21a465dca0a077cb9a9bb4f305f4219e7050c52dd43c287fbe/jade-md-0.0.4.tar.gz",
"platform": null,
"description": "# Jade\nJade is a markdown renderer for Flask applications.\n\nInitialise a new Jade project after installing with `python -m jade init`. This will create a simple Flask site with a home page, and a small blog, as an example of how to use the framework.\n\nTo get started, try editing the `content/home.md` file.\n\nAt the top of this file, you will see some `frontmatter`. This is `yaml` formatted content that is passed to the builder, and the template.\n\nWhile not required, the following `frontmatter` is recommended for each of your pages.\n\n* `permalink` - Where on the site you want the page to register. Defaults to the file's path within the `content` directory, without the file extension.\n* `template` - the name of the template in your `templates` directory to render the content into. Defaults to `default`.\n\n## Reserved names\n\n* `page` - You can access the page frontmatter in your templates through the `page` variable. For example, the title for this page would be accessed with `page.title`.\n\n* `pages` - The `pages` variable contains all subdirectories of the `content` directory. This can be useful for things such as rendering a blog home page, with a link to each post in a directory. Note that nested directories are not currently supported.\n\n* `site` - You can also access site parameters, such as the site name through the `site` variable in all of your templates. Any parameters that you need globally should be added to the `.jade-config.yaml` file, under the site key. Try updating the `name` key under `site` in the config file.\n\n\n## Contribution\nInstall development requirements with `pip install -r requirements-dev.txt`, then install `pre-commit` with `pre-commit install`. Ensure all `nox` tests are passing before creating a pull request.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Jade - A Python library for rendering markdown to HTML for Flask.",
"version": "0.0.4",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c6b3a39c84097fa4b089bd285d0dc4f44a0e39b6429914ba3e5037c28de8187a",
"md5": "29527435161d70caf26bc88ff8a8653c",
"sha256": "e373fed7d7ebbde421eab6846403484e67eab498b586217128fea80d84c3c951"
},
"downloads": -1,
"filename": "jade_md-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "29527435161d70caf26bc88ff8a8653c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8937,
"upload_time": "2023-01-28T14:07:06",
"upload_time_iso_8601": "2023-01-28T14:07:06.270983Z",
"url": "https://files.pythonhosted.org/packages/c6/b3/a39c84097fa4b089bd285d0dc4f44a0e39b6429914ba3e5037c28de8187a/jade_md-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "53fd54e04a88ba21a465dca0a077cb9a9bb4f305f4219e7050c52dd43c287fbe",
"md5": "a97ac810f14110affee4b16808ec5876",
"sha256": "44675f467c8f0aaf4fe649e97b224a680f0a0a48c6d5b5fcff6a373726bf38b1"
},
"downloads": -1,
"filename": "jade-md-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "a97ac810f14110affee4b16808ec5876",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7215,
"upload_time": "2023-01-28T14:07:07",
"upload_time_iso_8601": "2023-01-28T14:07:07.810524Z",
"url": "https://files.pythonhosted.org/packages/53/fd/54e04a88ba21a465dca0a077cb9a9bb4f305f4219e7050c52dd43c287fbe/jade-md-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-28 14:07:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "sam-kenney",
"github_project": "jade",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "flask",
"specs": []
},
{
"name": "jinja2",
"specs": []
},
{
"name": "markdown",
"specs": []
},
{
"name": "pyyaml",
"specs": []
}
],
"lcname": "jade-md"
}
JSON
