commit | 90fd29bddae7a8a83ff4108610f25b2b703e74f4 | [log] [tgz] |
---|---|---|
author | Dave Fisher <dave@davefisher.tech> | Tue Jun 08 17:43:38 2021 -0700 |
committer | Dave Fisher <dave@davefisher.tech> | Tue Jun 08 17:43:38 2021 -0700 |
tree | 2a75f829becefa66cf237372a187d2b8eca831c8 | |
parent | 675583d6ec4ba479b191a903dedacb05f38be45d [diff] |
switch to pulsar releases
This repository provides a website template for ASF-Pelican
Ask Infra to Use this template to create your new site repository
Update the theme‘s base.html
to fit your site’s requirements
Theme -- example template
The example has the following frameworks.
For fenced code hightlighting have a look at highlightjs
Images -- example logo and other images
Determine if your site requires a data model.
.ezmd
files in the content directory show examplesasfdata.yaml
has manuy examplesasfdata.py
and asfreader.py
Pluginsasfdata.yaml
data
directoryEdit your configuration
PLUGINS
ASF_DATA
- asfdata.py
plugin settingsASF_GENID
- asfgenid.py
plugin settings asfgenid.py
performs a series of html fixups including permalinks, heading ids, and table of contentsCreate your content
.md
files using Github Flavored Markdown (gfm.ezmd
files for templates using ASF_DATA
Building
Suggested Branch Strategy
Issues and Template Questions
Tools
GitHub Action -- A manual Lint action is provided:
Lint -- GitHub Actions Workflow
markdownlint -- using markdownlint-cli - Node.js style checker and lint tool for Markdown and CommonMark files
misspell -- Golang library to correct commonly misspelled English words quickly
yamllint -- a linter for YAML files
For misspell you can pass in -w
to autocorrect misspelled words. You can also autocorrect some markdownlint errors by using the --fix
flag.
EditorConfig -- helps maintain consistent coding styles for multiple developers working on the same project across various editors and IDEs
See the Developer Tools for tools that may be helpful.