https://github.com/lihbr/akte

Minimal file generator, for websites and more
https://github.com/lihbr/akte

akte generator javascript typescript

Last synced: 3 months ago
JSON representation

Minimal file generator, for websites and more

• Host: GitHub
• URL: https://github.com/lihbr/akte
• Owner: lihbr
• License: mit
• Created: 2023-01-07T16:31:33.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-05-12T14:37:04.000Z (9 months ago)
• Last Synced: 2024-10-30T22:05:20.894Z (3 months ago)
• Topics: akte, generator, javascript, typescript
• Language: TypeScript
• Homepage: https://akte.js.org
• Size: 2.63 MB
• Stars: 59
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


	

		

	



# akte

[![npm version][npm-version-src]][npm-version-href]

[![npm downloads][npm-downloads-src]][npm-downloads-href]

[![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]

[![Codecov][codecov-src]][codecov-href]

[![Conventional Commits][conventional-commits-src]][conventional-commits-href]

[![License][license-src]][license-href]

> **Warning**

> Akte is still pre-major (pre-1.0.0), it's usable, however, consider pinning the patch version before using.

A minimal static site (and file) generator.

- 🚕  Minimal and flexible;

- ⚡  Vite integration;

- 🛰  Serverless ready;

- 🎹  Programmatic API;

- 🌊  Controllable data cascade;

- 🈂  TypeScript supercharged;

- 🗜  Tiny install, 600kB;

- 💼  Portable, 6kB bundle size.

## Install

```bash

npm install --save-dev akte

```

## Documentation

To discover what's new on this package check out [the changelog][changelog]. For full documentation, check out the [official Akte documentation][documentation].

## Contributing

Whether you're helping me fix bugs, improve the site, or spread the word, I'd love to have you as a contributor!

**Asking a question**: [Open a new topic][repo-question] on GitHub Discussions explaining what you want to achieve / your question. I'll try to get back to you shortly.

**Reporting a bug**: [Open an issue][repo-bug-report] explaining your application's setup and the bug you're encountering.

**Suggesting an improvement**: [Open an issue][repo-feature-request] explaining your improvement or feature so we can discuss and learn more.

**Submitting code changes**: For small fixes, feel free to [open a pull request][repo-pull-requests] with a description of your changes. For large changes, please first [open an issue][repo-feature-request] so we can discuss if and how the changes should be implemented.

## License

[MIT License][license]

[documentation]: https://akte.js.org

[changelog]: ./CHANGELOG.md

[contributing]: ./CONTRIBUTING.md

[license]: ./LICENSE

[repo-question]: https://github.com/lihbr/akte/discussions

[repo-bug-report]: https://github.com/lihbr/akte/issues/new?assignees=&labels=bug&template=bug_report.md&title=

[repo-feature-request]: https://github.com/lihbr/akte/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=

[repo-pull-requests]: https://github.com/lihbr/akte/pulls

[npm-version-src]: https://img.shields.io/npm/v/akte/latest.svg

[npm-version-href]: https://npmjs.com/package/akte

[npm-downloads-src]: https://img.shields.io/npm/dm/akte.svg

[npm-downloads-href]: https://npmjs.com/package/akte

[github-actions-ci-src]: https://github.com/lihbr/akte/workflows/ci/badge.svg

[github-actions-ci-href]: https://github.com/lihbr/akte/actions?query=workflow%3Aci

[codecov-src]: https://img.shields.io/codecov/c/github/lihbr/akte.svg

[codecov-href]: https://codecov.io/gh/lihbr/akte

[conventional-commits-src]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg

[conventional-commits-href]: https://conventionalcommits.org

[license-src]: https://img.shields.io/npm/l/akte.svg

[license-href]: https://npmjs.com/package/akte