https://github.com/jflex-de/jflex-web
JFlex Website
https://github.com/jflex-de/jflex-web
jflex
Last synced: about 1 year ago
JSON representation
JFlex Website
- Host: GitHub
- URL: https://github.com/jflex-de/jflex-web
- Owner: jflex-de
- Created: 2015-03-21T01:57:54.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2023-02-05T05:13:24.000Z (over 3 years ago)
- Last Synced: 2023-02-28T06:56:25.506Z (over 3 years ago)
- Topics: jflex
- Language: HTML
- Size: 2.68 MB
- Stars: 3
- Watchers: 6
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# JFlex Website
This is the repository for the JFlex web site at http://jflex.de
The web site is generated by Hakyll, mostly based on bootstrap and markdown.
## Dependencies
You will need the Haskell compiler `ghc`, preferably from the [Haskell
platform][1], which includes the package manager `cabal`.
You can then run
cabal install hakyll
cabal install hjsmin
to get the [Hakyll][2] web site generator.
## Structure
Most of the content is in directory `pages` in the form of markdown or html
files, which have templates and css applied to them to form the website.
The content of `files` is copied verbatim to the site and contains
miscellaneous support files. Javascprit and CSS files are in `js` and `css`
respectively, and `templates` contains the template parts, including
navigation, header, footer, etc, that make up the site's pages.
Layout should mainly be controlled from `css/jflex.css` and `templates/*.html`,
content should all be in `pages/*.{md|html}`.
The build scripts expects the release `.tar.gz`, `.zip`, and `.sha1` files in
`release` which is not version controlled (supposed to be generated from a
tagged release version of the main jflex repo). The `docs/` directory is mostly
generated from the release files, but is version controlled (should be removed
once things are more integrated).
## Build
ghc --make site
./site watch
Point your web browser at http://127.0.0.1:8000 to see the local version.
See `site --help` for further commands. The `site watch` command should
automatically pick up any edits you make in templates and markdown files. If
you change `site.hs` you need to recompile.
## Deploy
To deploy, email Gerwin.
## License
Licensed under Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
[1]: https://www.haskell.org/platform/
[2]: http://jaspervdj.be/hakyll/