https://github.com/gvwilson/mccole

A simple static site generator and linter
https://github.com/gvwilson/mccole

Last synced: about 2 months ago
JSON representation

A simple static site generator and linter

• Host: GitHub
• URL: https://github.com/gvwilson/mccole
• Owner: gvwilson
• License: mit
• Created: 2024-04-01T00:21:13.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-09-01T01:07:02.000Z (4 months ago)
• Last Synced: 2024-09-01T09:27:08.068Z (4 months ago)
• Language: Python
• Homepage:
• Size: 623 KB
• Stars: 4
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# McCole

A tool for building very simple static websites.

All of the material is available under an [open license](./LICENSE.md),

and contributions through our [GitHub repository][repo] are welcome:

please see [the contributors guide](./CONTRIBUTING.md) for instructions.

All contributors are required to respect our [Code of Conduct](./CODE_OF_CONDUCT.md).

1.  `pip install mccole` to install.

2.  `mccole install` to copy the following tools into the current directory:

    -   `static/page.css`: styling for regular pages

    -   `static/slides.css`: styling for slides

    -   `static/slides.js`: JavaScript to make slides interactive

    -   `templates/page.html`: Jinja template for pages

    -   `templates/slides.html`: Jinja template for slides

After installation, the following commands will be available:

-   `mccole lint`: internal project check

-   `mccole render`: Markdown-to-HTML translator

-   `mccole stats`: site statistics

[repo]: https://github.com/gvwilson/mccole