https://github.com/joshuaestes/thoth

Static Site Generator using PHP
https://github.com/joshuaestes/thoth

markdown php static-site-generator twig

Last synced: 1 day ago
JSON representation

Static Site Generator using PHP

• Host: GitHub
• URL: https://github.com/joshuaestes/thoth
• Owner: JoshuaEstes
• License: mit
• Created: 2020-06-01T19:48:56.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-06-03T19:41:57.000Z (over 4 years ago)
• Last Synced: 2024-11-08T05:41:47.278Z (about 2 months ago)
• Topics: markdown, php, static-site-generator, twig
• Language: PHP
• Size: 26.4 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
Thoth

=====

PHP Static Site Generator

---

# Install

`composer global require "joshuaestes/thoth:dev-master"`

# Getting Started

# Configuration

Config done via .thoth.{yaml|yml} and .env{.local} files

```yaml

# .thoth.yml

theme: default # can use vendor/theme to pull from github

source: .

destination: ./public

```

# New Command

`thoth new [dir]`, "dir" defaults to currently directory

* Generates a new thoth project in given directory

# Watch Command

`thoth watch` will generate a new site if anything changes

* runs `thoth generate`

# Generate Command

`thoth generate` output to `/public`

* `/public` can be configured

# Serve Command

`thoth serve` will use php webserver to serve generated files?

* Option to --watch

# Deploy Command?

# Themes

Themes are stored in `themes` directory.

Directory is name of theme

themes/default

themes/blog

themes/docs

Theme files

* `base.html.twig`

* `home.html.twig`

* `page.html.twig`

* `post.html.twig`

* `_head.html.twig`

* `_header.html.twig`

* `_footer.html.twig`

* `full-width.layout.html.twig`

"included" files will be prefixed with an underscore

Assets are store in the `assets` directory for the theme, ie themes/blog/assets