{"id":13614564,"url":"https://github.com/dunglas/calavera","last_synced_at":"2025-05-06T21:22:21.192Z","repository":{"id":34676648,"uuid":"38649855","full_name":"dunglas/calavera","owner":"dunglas","description":"A (static) Single Page Application generator using Markdown files","archived":false,"fork":false,"pushed_at":"2017-03-15T16:20:36.000Z","size":50,"stargazers_count":16,"open_issues_count":4,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-31T03:03:29.553Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dunglas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-07-06T22:28:36.000Z","updated_at":"2022-12-12T16:55:40.000Z","dependencies_parsed_at":"2022-08-28T11:12:27.073Z","dependency_job_id":null,"html_url":"https://github.com/dunglas/calavera","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dunglas%2Fcalavera","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dunglas%2Fcalavera/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dunglas%2Fcalavera/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dunglas%2Fcalavera/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dunglas","download_url":"https://codeload.github.com/dunglas/calavera/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252770010,"owners_count":21801463,"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":[],"created_at":"2024-08-01T20:01:03.212Z","updated_at":"2025-05-06T21:22:21.151Z","avatar_url":"https://github.com/dunglas.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"# Calavera, a static Single Page Application generator\n\nCalavera helps to create a full-Javascript webapp from [Markdown](http://daringfireball.net/projects/markdown/) files.\n\nBasically, it converts Markdown files stored in a [Git](https://git-scm.com/) repository to [JSON-LD](http://json-ld.org/) files\nusing the [Schema.org](https://schema.org/) vocabulary.\nThose files include metadata extracted from the Git repository (author name, last modification date...).\n\nJSON-LD files are easily consumed by JavaScript libraries and framework such as [React](https://facebook.github.io/react/),\n[Angular](https://angular.io/) or [jQuery](https://jquery.com/).\n\nWebsites generated with Calavera can be freely and easily hosted on [GitHub Pages](https://pages.github.com/).\n\n[![Go Report Card](https://goreportcard.com/badge/github.com/dunglas/calavera)](https://goreportcard.com/report/github.com/dunglas/calavera)\n[![Travis](https://img.shields.io/travis/dunglas/calavera.svg?maxAge=2592000)](https://travis-ci.org/dunglas/calavera)\n[![Coveralls](https://img.shields.io/coveralls/dunglas/calavera.svg?maxAge=2592000)](https://coveralls.io/github/dunglas/calavera)\n[![Docker Automated buil](https://img.shields.io/docker/automated/dunglas/calavera.svg?maxAge=2592000)](https://hub.docker.com/r/dunglas/calavera/)\n\n## Install\n\nThe easiest way to use Calavera is through [Docker](https://www.docker.com). Just go to the usage section below.\n\nAlternatively, you can compile Calavera from sources.\n\nThe [Go](https://golang.org/) programming language is the only required dependency to compile Calavera.\n\nIf you don't already have a [Go workspace](https://golang.org/doc/code.html#Workspaces), create it: \n\n    $ mkdir -p ~/workspace/go\n    $ export GOPATH=~/workspace/go\n\nThen, download [govendor](https://github.com/kardianos/govendor) to manage the dependencies of the project:\n\n    $ go get -u github.com/kardianos/govendor\n\nCreate the appropriate directory structure and download the source code:\n\n    $ mkdir -p ~/workspace/go/src/github.com/dunglas\n    $ cd ~/workspace/go/src/github.com/dunglas\n    $ git clone git@github.com:dunglas/calavera.git\n\nGo to the source code directory, download external libraries and compile the program:    \n\n    $ cd calavera\n    $ ~/workspace/go/bin/govendor sync # Download dependencies\n    $ ~/workspace/go/bin/govendor install # Install the app\n\n## Usage\n\nUsing Docker:\n\n    $ docker run -v /my/src/directory:/in -v /my/output/directory:/out dunglas/calavera /in /out\n\nIf you installed it from source:\n\n    $ ~/workspace/go/bin/calavera input_directory output_directory\n\nMarkdown files from the `input_directory` will be converted to JSON-LD files in `output_directory`.\n\n### Options\n\n* **-prettify**: Prettify generated JSON-LD files\n\n## License\n\nCalavera is distributed under [the MIT license](LICENSE).\n\n## Credits\n\nWritten in Go (golang) by [Kévin Dunglas](https://dunglas.fr) and sponsored by [Les-Tilleuls.coop](https://les-tilleuls.coop).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdunglas%2Fcalavera","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdunglas%2Fcalavera","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdunglas%2Fcalavera/lists"}