<commit_before># Docs Bootstrap Template

A Bootstrap-based template for documentation pages, offering a modern and responsive look which adapts to all screen sizes.

The project is as simple as possible, consisting just of a few static webpages, as it is meant to be used as a basis for building more complex sites by adapting it to a templating engine or documentation framework such as Jinja, Maven Site or Sphinx, but offers all the features which a documentation site could need.

## Features

- Avoids unneeded complication to ease extensions.
- HTML5 semantic markup.
- Semantic tags for Facebook OpenGraph and Twitter Cards.
- Bootstrap, Font Awesome and highlight.js.
- Validated HTML 5, accessibility, CSS and JS.

## Check it

There is an [online demo site][demo-site] available for checking the template.

It will reflect always the contents of the master branch, showing the current version of the template.

## Usage

This is a static template meant to be used as a basis for dynamic templates. For this reason most of the html files are just showcases which serve as a visual guide for several documentation features.

These pages should be adapted for the actual final template, taking into consideration that the footer and heading will be mostly the same for all the pages.

The custom style and script files are kept in the '\_static' folder, which includes also the libraries used.

### Prerequisites

The project makes use of [Bootstrap 3][bootstrap], [JQuery][jquery], [Font Awesome][font-awesome] and [highlight.js][highlightjs]. All of them come included.

Otherwise, it is just plain HTML, so any browser can be used to check it.

## Collaborate

Any kind of help with the project will be well received, and there are two main ways to give such help:

- Reporting errors and asking for extensions through the issues management
- or forking the repository and extending the project

### Issues management

Issues are managed at the GitHub [project issues tracker][issues], where any Github user may report bugs or ask for new features.

### Getting the code

If you wish to fork or modify the code, visit the [GitHub project page][scm], where the latest versions are always kept. Check the 'master' branch for the latest release, and the 'develop' for the current, and stable, development version.

## License

The project has been released under the [MIT License][license].

[bootstrap]: http://getbootstrap.com/
[demo-site]: http://www.wandrell.com/docs-bootstrap-template/
[font-awesome]: http://fortawesome.github.io/Font-Awesome/
[highlightjs]: https://highlightjs.org/
[issues]: https://github.com/Bernardo-MG/docs-bootstrap-template/issues
[jquery]: https://jquery.com/
[license]: http://www.opensource.org/licenses/mit-license.php
[scm]: http://github.com/Bernardo-MG/docs-bootstrap-template<commit_msg>Improved the readme file.<commit_after># Docs Bootstrap Template

A Bootstrap-based HTML5 template for documentation pages, offering a modern and responsive look which adapts to all screen sizes and is easy to extend.

It is meant to be used as a basis for building documentation sites, and so should be adapted to a templating engine or documentation framework such as Jinja, Maven Site or Sphinx.

## Features

- Avoids unneeded complication to ease extensions.
- HTML5 semantic markup.
- Semantic tags for Facebook OpenGraph and Twitter Cards.
- Bootstrap, Font Awesome and highlight.js.
- Validated HTML 5, accessibility, CSS and JS.

## Check it

There is an [online demo site][demo-site] which always reflects the current contents of the master branch, which is the latest version of the template.

## Usage

This is static template is meant to be transformed into a dynamic one, through the use of the preferred framework.
 
For this the HTML files should be used as a basis, which will need to be adapted as much as required, and not used directly as offered.

The files contained in the '\_static' folder, which includes also the libraries used, should require little changes, but may require some corrections to adapt to any changes made.

### Prerequisites

The project makes use of [Bootstrap 3][bootstrap], [JQuery][jquery], [Font Awesome][font-awesome] and [highlight.js][highlightjs]. All of them come included in the '\_static\lib' folder.

Otherwise, it is just plain HTML5 and CSS3.

## Collaborate

Any kind of help with the project will be well received, and there are two main ways to give such help:

- Reporting errors and asking for extensions through the issues management
- or forking the repository and extending the project

### Issues management

Issues are managed at the GitHub [project issues tracker][issues], where any Github user may report bugs or ask for new features.

### Getting the code

If you wish to fork or modify the code, visit the [GitHub project page][scm], where the latest versions are always kept. Check the 'master' branch for the latest release, and the 'develop' for the current, and stable, development version.

## License

The project has been released under the [MIT License][license].

[bootstrap]: http://getbootstrap.com/
[demo-site]: http://www.wandrell.com/docs-bootstrap-template/
[font-awesome]: http://fortawesome.github.io/Font-Awesome/
[highlightjs]: https://highlightjs.org/
[issues]: https://github.com/Bernardo-MG/docs-bootstrap-template/issues
[jquery]: https://jquery.com/
[license]: http://www.opensource.org/licenses/mit-license.php
[scm]: http://github.com/Bernardo-MG/docs-bootstrap-template
{'fraction_non_alphanumeric': 0.07449127906976744, 'fraction_numerical': 0.0016351744186046512, 'mean_word_length': 4.54380664652568, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 6, 'lorem ipsum': 0, 'www.': 4, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1236746', 'n_tokens_mistral': 1436, 'n_tokens_neox': 1372, 'n_words': 740}