Apache Template

This repository provides a website template for ASF-Pelican

How to use this template

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.
  - JavaScript:
  - CSS:
    - Bootstrap 4.3.1
    - GitHub Markdown 3.0.1 For fenced code hightlighting have a look at highlightjs
- Images -- example logo and other images
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
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
Create your content
- .md files using Github Flavored Markdown (gfm)
- .ezmd files for templates using ASF_DATA
Building
- Local build instructions
- ASF YAML build -- ASF infrastructure instructions
Suggested Branch Strategy
Issues and Template Questions
Tools
- GitHub Actions
  - Lint manual workflow
- EditorConfig -- helps maintain consistent coding styles for multiple developers working on the same project across various editors and IDEs
  - .editorconfig