https://github.com/imabhinavdev/documentation
Explore comprehensive guides and resources on software development, web technologies, and more at docs.imabhinav.dev.
https://github.com/imabhinavdev/documentation
astro astro-theme docs documentation javascript mdx react vite website
Last synced: 4 months ago
JSON representation
Explore comprehensive guides and resources on software development, web technologies, and more at docs.imabhinav.dev.
- Host: GitHub
- URL: https://github.com/imabhinavdev/documentation
- Owner: imabhinavdev
- Created: 2024-06-18T12:01:56.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-11-14T08:07:53.000Z (over 1 year ago)
- Last Synced: 2025-02-10T22:46:35.108Z (over 1 year ago)
- Topics: astro, astro-theme, docs, documentation, javascript, mdx, react, vite, website
- Language: JavaScript
- Homepage: https://docs.imabhinav.dev
- Size: 304 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Documentation Website - docs.imabhinav.dev
Welcome to my documentation website! This site is dedicated to providing comprehensive guides and resources on various topics related to software development, web technologies, and more.
## Getting Started
To explore the documentation:
- Visit [docs.imabhinav.dev](https://docs.imabhinav.dev) to browse through the available topics and guides.
- Clone this repository to contribute or customize the documentation locally.
```bash
git clone https://github.com/imabhinavdev/documentation.git
cd docs.imabhinav.dev
```
## Project Structure
The documentation is organized with the following structure:
```
.
├── public/
├── src/
│ ├── assets/
│ ├── content/
│ │ └── docs/
│ │ ├── getting-started.md
│ │ ├── installation.md
│ │ └── ...
│ └── styles/
├── package.json
└── README.md
```
### Key Directories and Files:
- **`src/content/docs/`**: Contains Markdown files (`*.md`) for each documentation topic.
- **`src/assets/`**: Stores images and other static assets used in the documentation.
- **`public/`**: Static files and assets served by the website.
## Local Development
Follow these steps to run the documentation website locally:
1. Install dependencies:
```bash
npm install
```
2. Start the development server:
```bash
npm run dev
```
3. Open your browser and visit `http://localhost:4321` to view the documentation.
## Contributing
Contributions are welcome! If you'd like to contribute to the documentation:
1. Fork the repository and clone it locally.
2. Create a new branch for your changes:
```bash
git checkout -b feature/new-docs
```
3. Make your changes and commit them:
```bash
git commit -am 'Add new documentation on feature'
```
4. Push to your fork and submit a pull request.
## Resources
- [Visit the live documentation](https://docs.imabhinav.dev)
- [Astro Documentation](https://docs.astro.build)
- [React Documentation](https://reactjs.org/docs/getting-started.html)
- [Markdown Guide](https://www.markdownguide.org/getting-started/)
---