<commit_before>gollum -- A wiki built on top of Git
====================================

## DESCRIPTION

Gollum is a simple wiki built on top of Git that powers GitHub Wikis. Gollum
is designed so that you can create a compliant Git repository (known as a
Gollum repository) either by hand, by calling API methods, or via the web
interface.

We are making the source available so that you may test your wikis locally if
you choose to edit them by hand.


## REPO STRUCTURE

A Gollum repository's contents are designed to be human editable. Page content
is written in `page files` and may be organized into directories any way you
choose. Layouts can be created in `layout files`. Other content (images, PDFs,
etc) may also be present and organized in the same way.


## PAGE FILES

Page files may be written in formats that render to HTML. Currently supported
formats are Markdown and Textile. They must have the proper file extension
that corresponds to the format of the content:

  * Markdown: .markdown, .mkdn, .md
  * Textile: .textile

Even though page files may be placed in any directory, there is still only a
single namespace for page names, so all page files should have globally unique
names regardless of where they are located in the repository.

The special page file `home.ext` (where the extension is one of the supported
formats) will be used as the entrance page to your wiki. If it is missing, an
automatically generated table of contents will be shown instead.


## LAYOUT FILES

Layout files allow you to wrap page content with a header, footer, sidebar,
etc. Layout files must be named `_layout.ext` where the extension is one of
the supported formats. Layouts affect all pages in their directory and any
subdirectories that do not have layout files of their own.

Inside your layout file, you must use the following content link to specify
where the page content should reside:

    [[[content]]]

Here's a simple example:

    <div id="header">...</div>
    <div id="content">[[[content]]]</div>
    <div id="footer">...</div>


## HTML SANITIZATION

For security and compatibility reasons Gollum wikis may not contain custom CSS
or JavaScript. These tags will be stripped from the converted HTML.


## WIKI LINKS

Wiki links in Gollum are processed before page content is converted to HTML.
They take the following form:

    [[Page Name]]

If you'd like the link text to be something other than the page name, you can
use the advanced form:

    [[Page Name | Alternate Text]]

The above wiki links will create a link to the corresponding page file named
`page-name.ext` where `ext` may be any of the allowed extension types. The
conversion is as follows:

  1. Replace any non-alpha characters with a dash
  2. Lowercase all alpha characters

Here are a few more examples:<commit_msg>no layouts, just footers<commit_after>gollum -- A wiki built on top of Git
====================================

## DESCRIPTION

Gollum is a simple wiki built on top of Git that powers GitHub Wikis. Gollum
is designed so that you can create a compliant Git repository (known as a
Gollum repository) either by hand, by calling API methods, or via the web
interface.

We are making the source available so that you may test your wikis locally if
you choose to edit them by hand.


## REPO STRUCTURE

A Gollum repository's contents are designed to be human editable. Page content
is written in `page files` and may be organized into directories any way you
choose. Special footers can be created in `footer files`. Other content
(images, PDFs, etc) may also be present and organized in the same way.


## PAGE FILES

Page files may be written in formats that render to HTML. Currently supported
formats are Markdown and Textile. They must have the proper file extension
that corresponds to the format of the content:

  * Markdown: .markdown, .mkdn, .md
  * Textile: .textile

Even though page files may be placed in any directory, there is still only a
single namespace for page names, so all page files should have globally unique
names regardless of where they are located in the repository.

The special page file `home.ext` (where the extension is one of the supported
formats) will be used as the entrance page to your wiki. If it is missing, an
automatically generated table of contents will be shown instead.


## FOOTER FILES

Footer files allow you to add a simple footer to your wiki. Footer files must
be named `_footer.ext` where the extension is one of the supported formats.
Footers affect all pages in their directory and any subdirectories that do not
have footer files of their own.


## HTML SANITIZATION

For security and compatibility reasons Gollum wikis may not contain custom CSS
or JavaScript. These tags will be stripped from the converted HTML.


## WIKI LINKS

Wiki links in Gollum are processed before page content is converted to HTML.
They take the following form:

    [[Page Name]]

If you'd like the link text to be something other than the page name, you can
use the advanced form:

    [[Page Name | Alternate Text]]

The above wiki links will create a link to the corresponding page file named
`page-name.ext` where `ext` may be any of the allowed extension types. The
conversion is as follows:

  1. Replace any non-alpha characters with a dash
  2. Lowercase all alpha characters

Here are a few more examples:
{'fraction_non_alphanumeric': 0.05821981713006158, 'fraction_numerical': 0.0007464079119238664, 'mean_word_length': 4.075757575757576, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4834020', 'n_tokens_mistral': 1416, 'n_tokens_neox': 1348, 'n_words': 855}