Google Git
Sign in
apache / template-site / b97765d6f1f3e6d8ed26733e263f07f4185264ee
commitb97765d6f1f3e6d8ed26733e263f07f4185264ee[log] [tgz]
authorDave Fisher <dave2wave@comcast.net>Wed Jun 09 17:51:50 2021 -0700
committerGitHub <noreply@github.com>Wed Jun 09 17:51:50 2021 -0700
tree6392a81f60fe1cc291b8232b6e077f3e49eb599c
parent12b9f5d3466b3dd5e5d57fc71bb4670236e0ec5a [diff]
Update README.md
1 file changed
tree: 6392a81f60fe1cc291b8232b6e077f3e49eb599c
  1. .github/
  2. content/
  3. data/
  4. theme/
  5. .asf.yaml
  6. .editorconfig
  7. .gitignore
  8. .markdownlint.yaml
  9. .yamllint
  10. asfdata.yaml
  11. LICENSE
  12. NOTICE
  13. pelicanconf.py
  14. README.md
  15. requirements.txt
README.md

Apache Template

Apache Template

This repository provides a website template for ASF-Pelican

How to use this template

  1. Ask Infra to Use this template to create your new site repository

  2. Update the theme‘s base.html to fit your site’s requirements

  3. Determine if your site requires a data model.

    • The .ezmd files in the content directory show examples
    • asfdata.yaml has manuy examples
    • Remove the following if you do not need a data model:
      1. asfdata.py and asfreader.py Plugins
      2. asfdata.yaml
      3. data directory

  4. Edit your configuration

    • Website specific
    • PLUGINS
    • ASF_DATA - asfdata.py plugin settings
    • ASF_GENID - asfgenid.py plugin settings asfgenid.py performs a series of html fixups including permalinks, heading ids, and table of contents

  5. Create your content

    • .md files using Github Flavored Markdown (gfm
    • .ezmd files for templates using ASF_DATA

  6. Building

  7. Suggested Branch Strategy

  8. Issues and Template Questions

  9. Tools -Lint -- GitHub Actions manual workflow

    • Flake8 - Python based tool for style guide enforcement
    • 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