Apache Template

This repository provides a website template for ASF-Pelican

Pelican build site infrastructure is found here

If you use this template for your project website and provide a logo then your project should pass “Apache Project Website Checks”.

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 many examples
Edit your configuration
- Site specific information
- Theme path
- Plugin configuration. If you develop your own plugin or pull in plugins via pip then be sure to include it in use:
- Setup is used to add data models, shell scripts, ignored files and directories, and any special copy action.
- Genid invokes various special features including elementid and headingid with permalinks, table of contents, table class, and enabling of “unsafe” html.
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