Static page generator with Markdown support. Includes with Material Design, Less
CSS pre-processor and code highlighting.
Start by downloading and building the project when necessary. The following
commands will do the job on most Debian based Linux distributions.
git clone https://github.com/mbp76/markdown-pages cd markdown-pages sudo ./gradlew
After the installation process the contents will be generated inside the
folder. Run the
serve visit http://localhost:8000 to browse the project pages,
it is equivalent to running Python's SimpleHTTPServer.
sudo ./gradlew serve
Test checks are executed automatically every time the project is built. Builds
can be done remotely or continuously on a development context. For continuous
integration and development use docker-compose. This is recommended to keep the
system clean while the project is built every time the sources change.
sudo docker-compose up
For continuous integration and development without any dependencies use the
Gradle wrapper. This is the best option if the wrapper is available and the
Docker context is not valid. For a full list of tasks, see
sudo ./gradlew tasks --all. For a CI cycle use
sudo ./gradlew --continuous.
For continuous integration and development without Docker or the project wrapper
use Gradle directly. This will create the wrapper in case it is not present.
Similar to the above, for a CI cycle use
sudo gradle --continuous. Gradle
3.4.1 is required for this to work. Plain Docker is also available for remote
integration tasks and alike. Build the image with
sudo docker build . and run
a new container with it. Information on how to install Docker and docker-compose
can be found in their official page. A similar
installation guide is available for Gradle.
The issue tracker intends to manage and compile bugs,
enhancements, proposals and tasks. Reading through its material or reporting to
its contributors via the platform is strongly recommended.
This project adheres to Semantic Versioning and to certain syntax
conventions defined in .editorconfig. To get a list of changes
refer to the CHANGELOG. Only branches prefixed by feature-,
hotfix-, or release- will be considered:
- Fork the project.
- Create your new branch:
git checkout -b feature-my-feature develop
- Commit your changes:
git commit -am 'Added my new feature.'
- Push the branch:
git push origin feature-my-feature
- Submit a pull request.
This project is licensed under the Apache License Version 2.0.