Skip to content

Commit 7c6913e

Browse files
twicer-is-codertwicer-is-coder
committed
Added license and updated readme.
1 parent 1af3dad commit 7c6913e

File tree

3 files changed

+84
-25
lines changed

3 files changed

+84
-25
lines changed

‎LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 ModulesPress
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

Lines changed: 61 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,79 @@
1-
# Website
1+
# ModulesPress Documentation
22

3-
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
3+
<p align="center">
4+
<img src="static/img/logo.png" alt="ModulesPress Logo" width="200"/>
5+
</p>
46

5-
### Installation
7+
Welcome to the official documentation repository for ModulesPress! This repository contains the source code for our documentation website built with Docusaurus 3.
68

7-
```
8-
$ yarn
9-
```
9+
## 🚀 Quick Start
1010

11-
### Local Development
11+
```bash
12+
# Install dependencies
13+
npm install
1214

13-
```
14-
$ yarn start
15+
# Start development server
16+
npm start
17+
18+
# Build for production
19+
npm run build
1520
```
1621

17-
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
22+
## 📖 About
1823

19-
### Build
24+
ModulesPress documentation is built using [Docusaurus 3](https://docusaurus.io/), a modern static website generator. Our documentation aims to provide comprehensive guides, tutorials, and API references for ModulesPress users.
2025

21-
```
22-
$ yarn build
23-
```
26+
## 🤝 Contributing
2427

25-
This command generates static content into the `build` directory and can be served using any static contents hosting service.
28+
We welcome contributions from the community! Here's how you can help:
2629

27-
### Deployment
30+
### Setting up the Development Environment
2831

29-
Using SSH:
32+
1. Fork the repository
33+
2. Clone your fork: `git clone https://github.com/YOUR_USERNAME/modulespress-docs.git`
34+
3. Install dependencies: `npm install`
35+
4. Create a new branch: `git checkout -b feature/your-feature-name`
3036

31-
```
32-
$ USE_SSH=true yarn deploy
33-
```
37+
### Making Changes
3438

35-
Not using SSH:
39+
1. Make your changes to the documentation
40+
2. Test locally using `npm start`
41+
3. Ensure your changes follow our documentation style guide
42+
4. Commit your changes with clear, descriptive commit messages
43+
44+
### Submitting a Pull Request
45+
46+
1. Push your changes to your fork
47+
2. Submit a pull request to the main repository
48+
3. Describe your changes and why they're necessary
49+
4. Wait for review and address any feedback
50+
51+
### Documentation Style Guide
52+
53+
- Use clear, concise language
54+
- Include code examples where appropriate
55+
- Follow Markdown best practices
56+
- Add images and diagrams when they help explain concepts
57+
- Ensure all links are working
58+
- Include proper headings and subheadings
59+
60+
## 🔧 Project Structure
3661

3762
```
38-
$ GIT_USER=<Your GitHub username> yarn deploy
63+
modulespress-docs/
64+
├── docs/ # Documentation markdown files
65+
├── src/ # Custom components and pages
66+
├── static/ # Static assets
67+
├── docusaurus.config.ts # Docusaurus configuration
68+
└── sidebars.ts # Sidebar configuration
3969
```
4070

41-
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
71+
## 📝 License
72+
73+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
74+
75+
Key points:
76+
- ✅ Free to use, copy, modify, and distribute
77+
- ✅ Commercial use allowed
78+
- ❌ No warranty provided
79+
- Must include the original license and copyright notice

‎package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
2-
"name": "my-website",
3-
"version": "0.0.0",
2+
"name": "modulespress-docs",
3+
"version": "0.0.1",
44
"private": true,
55
"scripts": {
66
"docusaurus": "docusaurus",

0 commit comments

Comments
 (0)