Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/elegantframework/.github
Elegant is the easiest way to create a new static website or blog, and publish it online. No need for databases, external services, or complicated server setups. Built with Next.js, Tailwind CSS, Markdown loading, & much more.
https://github.com/elegantframework/.github
elegant jest markdown mdx next nextjs react reactjs storybook tailwindcss typescript
Last synced: 23 days ago
JSON representation
Elegant is the easiest way to create a new static website or blog, and publish it online. No need for databases, external services, or complicated server setups. Built with Next.js, Tailwind CSS, Markdown loading, & much more.
- Host: GitHub
- URL: https://github.com/elegantframework/.github
- Owner: elegantframework
- License: mit
- Created: 2023-07-11T20:00:30.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-04T21:03:51.000Z (about 1 year ago)
- Last Synced: 2024-11-12T10:25:00.153Z (3 months ago)
- Topics: elegant, jest, markdown, mdx, next, nextjs, react, reactjs, storybook, tailwindcss, typescript
- Size: 6.84 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Elegant is the easiest way to create a new static website or blog, and publish it online. No need for databases, external services, or complicated server setups.
Built with Next.js, Tailwind CSS, Markdown loading, & much more.
---
## Introduction
Elegant is a community-driven project for building, deploying, and maintaining websites easily.
Built with Next.js and Markdown loading, Elegant is perfect for blogging, documentation websites, or just about any type of web application.
### Key Features
- 🚀 Fast and easy setup
- 💾 No database
- 🏠 Self-host for free
- ✅ Optimized for all search engines
---
## Getting Started
To get started using Elegant, simply install our CLI tool:
```
npm install elegant-cli
```
Next, run the initialization command to create your website:
```
npx elegant-init
```
Visit [https://www.elegantframework.com/docs/installation](https://www.elegantframework.com/docs/installation) for the complete installation guide.
## Documentation
You can find the complete version of the Elegant documentation at [https://elegantframework.com/docs](https://elegantframework.com/docs)
## Community
The Elegant community can be found on [GitHub Discussions](https://github.com/orgs/elegantframework/discussions), where you can ask questions, voice ideas, and share your projects.
To chat with other community members you can join the [Elegant Discord](https://discord.gg/PwY38x4uvV).
Our [Code of Conduct](https://github.com/elegantframework/elegant-cli/blob/v2.3/CODE_OF_CONDUCT.md) applies to all Elegant community channels.
## Contributing
We've built Elegant because we feel that developers should be more empowered to create better websites and content. We hope that other startups and organizations can benefit from the project. We are thankful for any contributions from the community.
If you're interested in contributing to the Elegant project, please read our [contributing docs](https://github.com/elegantframework/docs/blob/main/CONTRIBUTING.md) **before submitting a pull request**.
### Feature Suggestions
Elegant is a community driven project, and open to all suggestions and ideas that help to empower developers everywhere.
Visit our [Feature Request](https://github.com/elegantframework/elegant-cli/issues/new?assignees=&labels=&projects=&template=feature_request.md&title=) page to submit your feedback.
### Reporting Issues
Bugs and user friction is our top priority. If you experience any issues or friction during your experience with Elegant, please submit a [Bug Report](https://github.com/elegantframework/elegant-cli/issues/new?assignees=&labels=&projects=&template=bug_report.md&title=).
### Good First Issues
We have a list of [good first issues](https://github.com/elegantframework/elegant-cli/labels/good%20first%20issue) that contain bugs and features that have a relatively limited scope. This is a great place to get started, gain experience, and get familiar with our contribution process.
## Stay Up-To-Date
The Elegant project is constantly evolving and improving on a daily basis. You can keep up and show your support by hitting the **Star** button! We really appreciate it! 😊
## License
The Elegant Framework is open-sourced software licensed under the [MIT license](https://opensource.org/license/mit/).
## Author
- Brandon Owens ([@thebrandonowens](https://twitter.com/thebrandonowens))