https://github.com/kartikmehta8/filer

A Docusaurus Alternative based on React, Tailwind & Parcel
https://github.com/kartikmehta8/filer

docusaurus parcel-bundler react tailwindcss

Last synced: about 2 months ago
JSON representation

A Docusaurus Alternative based on React, Tailwind & Parcel

• Host: GitHub
• URL: https://github.com/kartikmehta8/filer
• Owner: kartikmehta8
• Created: 2024-07-16T14:18:10.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-07-19T17:28:37.000Z (6 months ago)
• Last Synced: 2024-07-19T21:32:23.213Z (6 months ago)
• Topics: docusaurus, parcel-bundler, react, tailwindcss
• Language: JavaScript
• Homepage: https://filerdoc.vercel.app
• Size: 133 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

# Docusaurus Alternative Based on React, Tailwind & Parcel

![Banner](./assets/banner.png)

## Overview

This project is a Docusaurus alternative using React, Tailwind CSS, and Parcel. It features a collapsible sidebar for folders and files, dynamically rendering Markdown content.

## Features

- React for building UI

- Tailwind CSS for styling

- Parcel for bundling

- Dynamic Markdown rendering

## Installation

1. Clone the repository:

   ```bash

   git clone https://github.com/kartikmehta8/filer.git

   cd filer

   ```

2. Install dependencies:

   ```bash

   npm install

   ```

3. Generate routes:

   ```bash

   npm run generate-routes

   ```

4. Start the development server:

   ```bash

   npm start

   ```

5. Build the project:

   ```bash

   npm run build

   ```

## Project Structure

```

docusaurus-alternative/

├── public/

│   ├── routes.json

│   ├── index.html

├── src/

│   ├── components/

│   │   ├── Sidebar.js

│   │   ├── MarkdownRenderer.js

│   ├── docs/

│   ├── styles/

│   │   ├── App.css

│   │   ├── Sidebar.css

│   ├── App.js

│   ├── index.js

├── generateRoutes.js

├── package.json

├── .parcelrc

```

By [Mehta](https://mrmehta.in)