|
1 | 1 | # Janus |
2 | 2 |
|
3 | 3 | <p align="center"> |
4 | | - <img src="./static/img/janus.png"/> <br/> |
5 | | - A simple documentation boilerplate. |
| 4 | + <img src="./static/img/janus.png" alt="Janus Logo"/> <br/> |
| 5 | + A modern documentation website boilerplate powered by Docusaurus and Tailwind CSS |
6 | 6 | </p> |
7 | 7 |
|
8 | 8 | <p align="center"> |
9 | | - <img src="https://img.shields.io/github/release/ayoub3bidi/janus"> |
| 9 | + <img src="https://img.shields.io/github/release/ayoub3bidi/janus" alt="Release Version"/> |
| 10 | + <img src="https://img.shields.io/badge/Built%20With-Docusaurus-green" alt="Built With Docusaurus"/> |
| 11 | + <img src="https://img.shields.io/badge/Styled%20With-Tailwind-blue" alt="Styled With Tailwind"/> |
10 | 12 | </p> |
11 | 13 |
|
12 | | -## Features |
13 | | -* Search Bar |
14 | | -* Translation |
15 | | -* Tailwind CSS styling |
| 14 | +## 🚀 Overview |
16 | 15 |
|
17 | | -## Commands |
| 16 | +Janus is a powerful documentation website boilerplate that combines the robust features of Docusaurus with the utility-first approach of Tailwind CSS. It's designed to help you create beautiful, functional, and multilingual documentation websites with minimal setup. |
18 | 17 |
|
19 | | -All commands are run from the root of the project, from a terminal: |
| 18 | +## ✨ Features |
20 | 19 |
|
21 | | -| Command | Action | |
22 | | -|:-----------------------------------------------------------|:----------------------------------------------------------------------------------------------| |
23 | | -| `pnpm install` | Installs dependencies | |
24 | | -| `pnpm start` | Starts local dev server at `localhost:3000` | |
25 | | -| `pnpm build` | Build your production site to `./dist/` | |
26 | | -| `pnpm serve` | Preview your build locally, before deploying | |
27 | | -| `pnpm run write-translations --locale fr` | Generate the translation fields inside i18n folder after making texts between `Translate` tag | |
28 | | -| `pnpm run start --locale fr` | Run the french version of the project locally | |
29 | | -| `docker-compose -f docker-compose-local.yml up --build -d` | Run local development with Docker | |
| 20 | +- **📝 Docusaurus Foundation**: Built on top of Docusaurus, providing a stable and feature-rich documentation framework |
| 21 | +- **🎨 Tailwind CSS Integration**: Modern, responsive styling with the utility-first CSS framework |
| 22 | +- **🔍 Search Functionality**: Built-in search capabilities to help users find content quickly |
| 23 | +- **🌐 Internationalization**: Full i18n support with easy translation management |
| 24 | +- **📱 Mobile Responsive**: Looks great on devices of all sizes |
| 25 | +- **🐳 Docker Support**: Easy development and deployment with Docker |
| 26 | + |
| 27 | +## 🛠️ Quick Start |
| 28 | + |
| 29 | +1. Clone the repository: |
| 30 | +```bash |
| 31 | +git clone https://github.com/ayoub3bidi/janus.git |
| 32 | +cd janus |
| 33 | +``` |
| 34 | + |
| 35 | +2. Install dependencies: |
| 36 | +```bash |
| 37 | +pnpm install |
| 38 | +``` |
| 39 | + |
| 40 | +3. Start the development server: |
| 41 | +```bash |
| 42 | +pnpm start |
| 43 | +``` |
| 44 | + |
| 45 | +Your site should now be running at `http://localhost:3000` |
| 46 | + |
| 47 | +## 📦 Available Commands |
| 48 | + |
| 49 | +All commands are run from the root of the project: |
| 50 | + |
| 51 | +| Command | Description | |
| 52 | +|---------|------------| |
| 53 | +| `pnpm install` | Installs project dependencies | |
| 54 | +| `pnpm start` | Starts development server at `localhost:3000` | |
| 55 | +| `pnpm build` | Builds production site to `./dist/` | |
| 56 | +| `pnpm serve` | Previews production build locally | |
| 57 | + |
| 58 | +### Translation Commands |
| 59 | + |
| 60 | +| Command | Description | |
| 61 | +|---------|------------| |
| 62 | +| `pnpm run write-translations --locale fr` | Generates translation fields in i18n folder for French | |
| 63 | +| `pnpm run start --locale fr` | Runs the French version locally | |
| 64 | + |
| 65 | +### Docker Commands |
| 66 | + |
| 67 | +| Command | Description | |
| 68 | +|---------|------------| |
| 69 | +| `docker-compose -f docker-compose-local.yml up --build -d` | Runs development environment in Docker | |
| 70 | + |
| 71 | +## 🌐 Internationalization |
| 72 | + |
| 73 | +Janus comes with built-in support for multiple languages. To add translations: |
| 74 | + |
| 75 | +1. Wrap your text in `<Translate>` tags |
| 76 | +2. Generate translation files using the translation command |
| 77 | +3. Add translations to the generated files |
| 78 | +4. Run the site in your desired language |
| 79 | + |
| 80 | +## 🤝 Contributing |
| 81 | + |
| 82 | +Contributions are welcome! Please feel free to submit a Pull Request. |
| 83 | + |
| 84 | +## 📝 License |
| 85 | + |
| 86 | +This project is licensed under the [MIT License](LICENSE). |
| 87 | + |
| 88 | +## 🙏 Acknowledgments |
| 89 | + |
| 90 | +- Built with [Docusaurus](https://docusaurus.io/) |
| 91 | +- Styled with [Tailwind CSS](https://tailwindcss.com/) |
0 commit comments