{"id":21075986,"url":"https://github.com/marcbperez/markdown-pages","last_synced_at":"2026-04-09T09:58:08.815Z","repository":{"id":258607981,"uuid":"85006678","full_name":"marcbperez/markdown-pages","owner":"marcbperez","description":"A Static Site Generator for Markdown powered by Gradle, Pandoc, Spock, Preact and a minimalistic template.","archived":false,"fork":false,"pushed_at":"2024-11-12T14:36:53.000Z","size":252,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-20T22:52:41.333Z","etag":null,"topics":["gradle","markdown","pandoc","preact","spock","static-site-generator"],"latest_commit_sha":null,"homepage":"https://marcbperez.github.io/markdown-pages/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/marcbperez.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-03-14T23:18:05.000Z","updated_at":"2024-11-12T14:37:07.000Z","dependencies_parsed_at":"2025-01-20T22:47:07.578Z","dependency_job_id":"c41ffd16-394f-4ec6-be8a-8680843614d2","html_url":"https://github.com/marcbperez/markdown-pages","commit_stats":null,"previous_names":["marcbperez/markdown-pages"],"tags_count":21,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcbperez%2Fmarkdown-pages","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcbperez%2Fmarkdown-pages/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcbperez%2Fmarkdown-pages/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcbperez%2Fmarkdown-pages/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/marcbperez","download_url":"https://codeload.github.com/marcbperez/markdown-pages/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243521215,"owners_count":20304183,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["gradle","markdown","pandoc","preact","spock","static-site-generator"],"created_at":"2024-11-19T19:25:56.383Z","updated_at":"2025-12-29T09:04:20.770Z","avatar_url":"https://github.com/marcbperez.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# markdown-pages\n\nA Static Site Generator for Markdown powered by Gradle, Pandoc, Spock, Preact\nand a minimalistic template.\n\n## Installation\n\nClone the sources in Debian with Java 18 or newer and install the project\ndependencies. Information on how to install Java can be found in the\n[official documentation][install-java].\n\n```bash\ngit clone https://github.com/marcbperez/markdown-pages\ncd markdown-pages\nsudo ./gradlew install\n```\n\nFor end users, `install.sh` downloads a tarball of the release, runs the full \ninstallation process and adds `bin/markdown-pages` to the path.\n\n## Usage\n\nFor continuous integration and development use the Gradle wrapper. Without\nparameters, it will build the project into the `docs` folder and run tests. The\n`serve` task will use the build folder to start a development server at\n[http://localhost:8000][dev-server].\n\n```bash\n./gradlew\n./gradlew serve\n```\n\nFor a continuous build use `./gradlew --continuous`. For a full list of tasks,\nsee `./gradlew tasks --all`. Without the wrapper use Gradle directly. This will\ncreate it in case it is not present. The equivalent commands use `gradle`\ninstead of `./gradlew`. Information on how to install Gradle can be found in the\n[official documentation](install-gradle).\n\nThe `bin/markdown-pages` script runs a continuous build and serves the results\nat the same time using the wrapper. It can replace the commands described above\nand works from any directory.\n\n```bash\nexport PATH=$(pwd)/bin:$PATH\nmkdir ~/my-site\ncd ~/my-site\necho \"# Home\" \u003e index.md\nmarkdown-pages\n```\n\n## Testing\n\nTest checks are executed automatically every time the project is built. To run \nthem manually use the `./gradlew test` command. It will execute all the Spock\ntests from the `test` folder whose names match `test/**/*Spec.groovy`.\n\n## Deployment\n\nThe generated site can be deployed to any HTTP server by uploading the `docs` \nfolder and using it as the public directory.\n\n## Troubleshooting\n\nThe [issue tracker][issue-tracker] intends to manage and compile bugs,\nenhancements, proposals and tasks. Reading through its material or reporting to\nits contributors via the platform is strongly recommended.\n\n## Contributing\n\nThis project adheres to [Semantic Versioning][semver] and to certain syntax\nconventions defined in [.editorconfig][editorconfig]. To get a list of changes\nrefer to the [CHANGELOG][changelog]. Only branches prefixed by *feature-*,\n*hotfix-*, or *release-* will be considered:\n\n  - Fork the project.\n  - Create your new branch: `git checkout -b feature-my-feature develop`\n  - Commit your changes: `git commit -am 'Added my new feature.'`\n  - Push the branch: `git push origin feature-my-feature`\n  - Submit a pull request.\n\n## Credits\n\nCreated by [Marc B. Perez][author] and maintained by its [author][author] and\ncontributors.\n\n## License\n\nThis project is licensed under the [Apache License Version 2.0][license].\n\n[author]: https://marcbperez.github.io\n[issue-tracker]: https://github.com/marcbperez/markdown-pages/issues\n[editorconfig]: .editorconfig\n[changelog]: CHANGELOG.md\n[license]: LICENSE\n[semver]: http://semver.org\n[install-gradle]: https://gradle.org/install\n[install-java]: https://wiki.debian.org/Java#Quick_Install_Guide\n[markdown-pages]: https://github.com/marcbperez/markdown-pages\n[dev-server]: http://localhost:8000\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarcbperez%2Fmarkdown-pages","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarcbperez%2Fmarkdown-pages","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarcbperez%2Fmarkdown-pages/lists"}