# oranda
> Create beautiful and simple HTML pages from your Readme.md files
Latest version **0.0.3** (published 2022-09-27) · MIT license · 0 weekly downloads
## Install
```sh
npm install oranda
pnpm add oranda
yarn add oranda
bun add oranda
```
Provides the command `oranda`.
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support; pre 1.0.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 0.0.3 |
| Published | 2022-09-27 |
| First published | 2022-09-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=12.0.0 |
| Dependencies | 23 |
| Unpacked size | 46.7 KB |
| Known vulnerabilities | 0 (+36 in 4 direct dependencies) |
| Install scripts | no |
| GitHub stars | 546 |
| Author | Sara Vieira |
| Maintainers | saravieira |
| Keywords | generation, markdown, static, sites, oranda |
## Links
- npm: https://www.npmjs.com/package/oranda
- Repository: https://github.com/axodotdev/oranda
- Issues: https://github.com/axodotdev/oranda/issues
- npm.io page: https://npm.io/package/oranda
## Dependencies (23)
- [toml](https://npm.io/package/toml.md) ^3.0.0
- [axios](https://npm.io/package/axios.md) ^0.27.2
- [to-css](https://npm.io/package/to-css.md) ^1.2.1
- [gluegun](https://npm.io/package/gluegun.md) 5.1.2
- [gh-pages](https://npm.io/package/gh-pages.md) ^4.0.0
- [imagemin](https://npm.io/package/imagemin.md) ^8.0.1
- [jpegtran](https://npm.io/package/jpegtran.md) ^2.0.0
- [clean-css](https://npm.io/package/clean-css.md) ^5.3.1
- [node-sass](https://npm.io/package/node-sass.md) ^7.0.3
- [snarkdown](https://npm.io/package/snarkdown.md) ^2.0.0
- [create-html](https://npm.io/package/create-html.md) ^4.1.0
- [markdown-it](https://npm.io/package/markdown-it.md) ^13.0.1
- [markdownlint](https://npm.io/package/markdownlint.md) ^0.26.2
- [normalize.css](https://npm.io/package/normalize.css.md) ^8.0.1
- [imagemin-jpegtran](https://npm.io/package/imagemin-jpegtran.md) ^7.0.0
- [imagemin-pngquant](https://npm.io/package/imagemin-pngquant.md) ^9.0.2
- [markdown-it-emoji](https://npm.io/package/markdown-it-emoji.md) ^2.0.2
- [markdown-it-shiki](https://npm.io/package/markdown-it-shiki.md) ^0.5.1
- [markdown-it-anchor](https://npm.io/package/markdown-it-anchor.md) 8.6.5
- [markdown-it-checkbox](https://npm.io/package/markdown-it-checkbox.md) ^1.1.0
- [markdown-it-for-inline](https://npm.io/package/markdown-it-for-inline.md) ^0.1.1
- [markdown-it-github-headings](https://npm.io/package/markdown-it-github-headings.md) ^2.0.1
- [markdown-it-inline-comments](https://npm.io/package/markdown-it-inline-comments.md) ^1.0.1
## Alternatives
- [localforage](https://npm.io/package/localforage.md) — 6.2M weekly downloads
- [localforage-observable](https://npm.io/package/localforage-observable.md) — 30.8K weekly downloads
- [@y/y](https://npm.io/package/@y/y.md) — 30.1K weekly downloads
- [@metaobjectsdev/render](https://npm.io/package/@metaobjectsdev/render.md) — 3.5K weekly downloads
- [@ledgerhq/coin-algorand](https://npm.io/package/@ledgerhq/coin-algorand.md) — 1.1K weekly downloads
## Recent versions
- 0.0.3 (latest) — 2022-09-27
- 0.0.2 — 2022-09-22
- 0.0.1 — 2022-09-22
## README
# oranda
> 🎁 generate beautiful landing pages for your projects
[](https://crates.io/crates/oranda)
[](https://github.com/axodotdev/oranda/actions/workflows/ci.yml)
[](https://github.com/axodotdev/oranda/actions/workflows/release.yml)
[](https://github.com/axodotdev/oranda/actions/workflows/web.yml)
`oranda` is an opinionated static-site generator that is designed for developers
who are publishing projects and would like a website but don't want to build
one from scratch.
`oranda` uses `oranda` so you can checkout a live example [here][website]!
## Installation
To install `oranda`, please visit the [`oranda` website][website]- which is generated by
`oranda`!
[website]: https://axodotdev.github.io/oranda
## Quickstart
```sh
# build your site
> oranda build
# build your site and start a server that rebuilds on file changes
> oranda dev
```
Here's an animated demo:
## Configuration
First of all: `oranda` is designed to work without a configuration file. For a lot of projects,
you can likely just run `oranda build` and get a site that contains a couple of things that
`oranda` was automatically able to glean about your project. That being said, it also supports
a configuration file that allows you to tweak many things about oranda's behaviour.
If you'd like to configure `oranda`, place an `oranda.json` file in the root of
your project and fill it with the configuration you'd like. Check out the [docs]
to learn more about your configuration options!
[docs]: https://axodotdev.github.io/oranda/book/configuration.html
## Installers: integrating with `cargo-dist`
`oranda` has first-class integration with [`cargo-dist`], a tool that builds
distributable artifacts for your Rust applications. If you have `cargo-dist`
configured in your project correctly, `oranda` will be able to automatically
tell. Benefits of integrating with `cargo-dist` include:
- Installer scripts: `cargo-dist` can generate one-line installer scripts, which
`oranda` will display in your generated page
- Guaranteed platform support: `oranda` tries to support as many platforms as it can,
but if you build something with `cargo-dist`, we guarantee it'll show up correctly
[`cargo-dist`]: https://github.com/axodotdev/cargo-dist
## Contributing
Feel free to open a new issue or pull request if you notice something off or have a new feature
request! We sometimes tag issues with [good first issue] for issues that we think would make
a good learning experience for new contributors.
For local development on oranda, we also have a [special docs page][contributing-docs] with some tips.
[good first issue]: https://github.com/axodotdev/oranda/labels/good%20first%20issue
[contributing-docs]: https://axodotdev.github.io/oranda/book/contributing.html
---
_Source: https://npm.io/package/oranda · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._