52 lines
1.7 KiB
Markdown
52 lines
1.7 KiB
Markdown
|
# Isidore
|
||
|
|
|
||
|
|
A script helping to statically generate websites using a combination of PHP,
|
||
|
|
HTML, and Markdown.
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
Synopsis: `isidore <command> [options]`
|
||
|
|
|
||
|
|
Commands:
|
||
|
|
|
||
|
|
- `new <dir>`: create a new project directory `<dir>`.
|
||
|
|
- `build`: build the website (default).
|
||
|
|
- `clean`: cleans build files.
|
||
|
|
- `-h`, `--help`, `help`: show help information.
|
||
|
|
- `-V`, `--version`, `version`: show Isidore version number.
|
||
|
|
|
||
|
|
### New Project
|
||
|
|
|
||
|
|
When you create a new project with Isidore it will create the following
|
||
|
|
directory structure:
|
||
|
|
|
||
|
|
- `<dir>/`: the project directory.
|
||
|
|
- `site/`: contains the pages to be compiled.
|
||
|
|
- `templates/`: templates that can be used in `pages/` and can also be compiled.
|
||
|
|
- `output/`: output directory of compiled HTML files.
|
||
|
|
- `config.php`: configuration file with Isidore configuration and global
|
||
|
|
variables.
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
Currently the project is still under heavy development. The idea isn't to create
|
||
|
|
some massive static site generator project, as projects like this already exist
|
||
|
|
(e.g. Hugo). The point is to create a simple program with very little
|
||
|
|
functionality, that a user can then manually edit to add extra functionality.
|
||
|
|
Though I may consider adding a directory in the project containing patch files
|
||
|
|
if anyone ever wants to send one in.
|
||
|
|
|
||
|
|
In any case, if you want to contribute towards the development of the project,
|
||
|
|
please take a look at what needs to be done in the [roadmap](/ROADMAP.md), or
|
||
|
|
check if there are any to-do comments in the code:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
grep -r "TODO" src/
|
||
|
|
```
|
||
|
|
|
||
|
|
## License & Copyright
|
||
|
|
|
||
|
|
This project is licensed under the terms & conditions of the GNU Affero General
|
||
|
|
Public License version 3 (see the [license file](/LICENSE)) for more
|
||
|
|
information.
|