{"id":23038786,"url":"https://github.com/kauefraga/pavus","last_synced_at":"2025-08-14T18:33:02.695Z","repository":{"id":253032165,"uuid":"841708098","full_name":"kauefraga/pavus","owner":"kauefraga","description":"The next-gen markdown tool. Need to preview your markdown? Need templates for your README? It got your back!","archived":false,"fork":false,"pushed_at":"2024-08-20T02:22:13.000Z","size":191,"stargazers_count":6,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-08-20T18:47:04.333Z","etag":null,"topics":["go","markdown","markdown-previewer","readme","readme-template"],"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/kauefraga.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-12T23:12:08.000Z","updated_at":"2024-08-20T13:11:01.000Z","dependencies_parsed_at":"2024-08-17T18:25:50.044Z","dependency_job_id":null,"html_url":"https://github.com/kauefraga/pavus","commit_stats":null,"previous_names":["kauefraga/pavus"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kauefraga%2Fpavus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kauefraga%2Fpavus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kauefraga%2Fpavus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kauefraga%2Fpavus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kauefraga","download_url":"https://codeload.github.com/kauefraga/pavus/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229857937,"owners_count":18135148,"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":["go","markdown","markdown-previewer","readme","readme-template"],"created_at":"2024-12-15T18:25:26.422Z","updated_at":"2025-08-14T18:33:02.679Z","avatar_url":"https://github.com/kauefraga.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# `pavus` [![GitHub Release](https://img.shields.io/github/v/release/kauefraga/pavus?label=latest+version)](https://github.com/kauefraga/pavus/releases/latest) [![GitHub Last Commit](https://img.shields.io/github/last-commit/kauefraga/pavus/main)](https://github.com/kauefraga/pavus/commits/main/) [![Go Reference](https://pkg.go.dev/badge/github.com/kauefraga/pavus)](https://pkg.go.dev/github.com/kauefraga/pavus)\n\n**Next-generation markdown tool**\n\nPreview your markdown file, generate one from templates and more. Add pavus in your toolchain!\n\n[Getting started](#usage) •\n[Installation](#installation) •\n[Templates](#templates) •\n[Contributing](#contributing)\n\n## Key Features\n\n- Simplicity and power - just a single binary with all the batteries included\n- Tailored experience - descriptive messages, interactive mode and colorful outputs\n- Templates - just focus on your content\n- Configurable - but awesome defaults (not available yet)\n\nWant to know what's coming? Take a look at the [roadmap](https://github.com/kauefraga/pavus/issues/3).\n\n## Usage\n\n### Installation\n\n- Via [pkg.go.dev](https://pkg.go.dev/github.com/kauefraga/pavus) (not available yet)\n- Prebuilt binary\n\nCheck the [latest release](https://github.com/kauefraga/pavus/releases/latest) page to install the prebuilt binary for your platform.\n\nIf there is no binary for your platform you can build it yourself, see [how to build](#how-to-build).\n\n### Templates\n\n### Mastering the CLI\n\nReference about the command-line interface: available commands, examples, flags and aliases.\n\nTry `pavus --help` and `pavus help [command]`.\n\n##### Available commands\n\n- `pavus [markdown]` - preview a markdown file in the browser with hot reload\n- `pavus init` - create a markdown file based in a template\n- `pavus templates` - list available markdown templates\n\n##### Aliases\n\n- `pavus init`, `pavus i`, `pavus create`, `pavus c`\n\n##### Examples\n\n###### Root command (preview)\n\nPreview a markdown file, in this case, \"README.md\"\n\n```sh\npavus README.md\n```\n\nIf no file is passed to pavus, it will automatically look for one\n\n```sh\npavus\n```\n\nThe flag `-o --open-browser` can be used to open the preview in your default browser\n\n```sh\npavus README.md --open-browser\n```\n\nThe flag `-a --asset-directory \u003cdirectory\u003e` can be used to specify the assets directory (images and other resources being used in the markdown)\n\n```sh\n# - README.md\n# - public/\n#   - demo.gif\n#   - header.png\n#   - ...\n\npavus README.md --asset-directory public/\n```\n\n###### Init command\n\nCreate a markdown file based in a template interactively\n\nIt'll ask you for a template name and an output file name\n\n```sh\npavus init\n```\n\nLooking for flags?\n\n```sh\n# non-interactive\npavus init --template \"tooling\" --output \"my-docs.md\"\n\n# shorthand flags\npavus init -t tooling -o my-docs.md\n\n# fill the missing extension (.md) and only prompts for the template name\npavus init -o my-docs\n```\n\n###### Templates command\n\nList pavus available markdown templates\n\n```sh\npavus templates\n```\n\n### Mastering the configs\n\n## Contributing\n\nFeel free to contribute [opening an issue](https://github.com/kauefraga/pavus/issues/new) to report a bug or suggesting a CLI change, an improvement or a feature.\n\n### How to contribute\n\n1. Fork this project\n2. Clone your fork on your machine\n3. Setup the [dev environment](#how-to-setup-dev-environment)\n4. Make your changes and commit them following [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)\n5. Run `git push` to sync the changes\n6. Open a pull request specifying what you did\n\n### How to setup dev environment\n\n- Have [Go](https://go.dev/) installed (Preferably [1.22.5](go.mod))\n\nInstall the dependencies\n\n```sh\ngo mod download\n```\n\nAnd/or just run the project\n\n```sh\ngo run cmd/main.go\n```\n\n## How to build\n\nWith [Go](https://go.dev/) installed, building pavus should be as easy as running the following command\n\n```sh\ngo build cmd/main.go -o pavus\n```\n\nHowever, running the command below should generate a more lightweight binary\n\n```sh\nCGO_ENABLED=0 go build -ldflags='-w -s' cmd/main.go -o pavus\n```\n\nIn the [`build.sh`](build.sh) you can see how the release binaries are being built.\n\n## License\n\nThis project is licensed under the MIT License - See the [LICENSE](https://github.com/kauefraga/pavus/blob/main/LICENSE) for more information.\n\n---\n\nSe você gostou do projeto e ele te ajudou, considere [me apoiar um café](https://pixmeacoffee.vercel.app/kauefraga) ☕ 🇧🇷\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkauefraga%2Fpavus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkauefraga%2Fpavus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkauefraga%2Fpavus/lists"}