Skip to content

README.md

Latest commit

 

History

History
56 lines (43 loc) · 2.49 KB

README.md

File metadata and controls

56 lines (43 loc) · 2.49 KB

Greetings, a Lua Filter Template

GitHub build status

Greetings is a friendly Lua filter that adds a welcoming message to the document.

This repository serves as a template intended to make publishing of pandoc Lua filters easy and convenient. Just click "use this template" and then make modifications in your new repository. See also the GitHub documentation on creating a repository from a template.

Checklist

This is just a template, so a few things should be changed to make good use of this template. You can use the checklist below to ensure that you get the most out of it. We recommend that you perform at least the first two steps, everything else is up to you.

  1. Rename the filter: rename the filter greetings.lua to your chosen name. It's often a good idea to make the filter name match the repository name: if your repository is named lorem, then the filter should be named lorem.lua.

  2. Update the license: The template is published under the MIT, and we recommend to keep the same license for your code. You should update the LICENSE file so it has your name.

  3. Update this README: describe your filter, so people will know what to expect. You may also want to update the URLs above to match your repository.

  4. Build and serve the documentation: this template provides a tool to build an HTML documentation. Execute make docs to update the documentation. The documentation website files are located in the docs folder and can be published with GitHub Pages (see the GitHub documentation on configuring GitHub Pages).

License

This pandoc Lua filter is published under the MIT license, see file LICENSE for details.