Skip to content
Permalink
Browse files
Create asf-pelican-config.md
Moved information from the git repo. Will link to here from there.
  • Loading branch information
cottage14 committed May 5, 2022
1 parent 96a8eb4 commit 8045392b11aaa5273d6236e9bdcfb8f18a7801b4
Showing 1 changed file with 72 additions and 0 deletions.
@@ -0,0 +1,72 @@
Title: Configuring ASF Pelican

Review <a href="https://github.com/apache/template-site" target="_blank">github.com/apache/template-site</a> to inspect a full `pelicanconf.yaml` file.

These are the sections to configure in `pelicanconf.yaml` for your website:

## Required

```
site:
name: Apache Template
description: Provides a template for projects wishing to use the Pelican ASF static content system
domain: template.apache.org
logo: images/logo.png
repository: https://github.com/apache/template-site/blob/main/content/
trademarks: Apache, the Apache feather logo, and "Project" are trademarks or registered trademarks
theme: theme/apache
```

## Options

### Plugins

If you are using the standard plugins included in Pelican ASF, you can leave this section out.
Your build will automatically include the `gfm` plugin.

```
plugins:
paths:
- theme/plugins
use:
- gfm
```

### Special setup

To configure four special features:

```
setup:
data: asfdata.yaml
run:
- /bin/bash shell.sh
ignore:
- README.md
- include
- docs
copy:
- docs
```

1. data - uses `asfdata` plugin to build a data model to use in `ezmd` files. www-site is the best example.
2. run - uses `asfshell` plugin to run scripts. httpd-site's security vulnerability processing is the best example.
3. ignore - sets Pelican's IGNORE_FILES setting.
4. copy - uses `asfcopy` plugin to copy static files outside of the pelican process. Include these in ignore as well.
This is useful if you have large files or many static files.

## Generate ID

The `asfgenid` plugin performs a number of fixups and enhancements.

```
genid:
unsafe: yes
metadata: yes
elements: yes
headings_depth: 4
permalinks: yes
toc_depth: 4
tables: yes
```

0 comments on commit 8045392

Please sign in to comment.