https://github.com/ojacques/markdown-processes
Simple static web site to describe and follow processes
https://github.com/ojacques/markdown-processes
Last synced: about 1 year ago
JSON representation
Simple static web site to describe and follow processes
- Host: GitHub
- URL: https://github.com/ojacques/markdown-processes
- Owner: ojacques
- Created: 2024-12-01T17:59:43.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-01T18:24:13.000Z (over 1 year ago)
- Last Synced: 2025-06-12T19:58:20.742Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://ojacques.github.io/markdown-processes/
- Size: 277 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Process Guide App
A dynamic web application for managing and following step-by-step processes with interactive features and local progress tracking.
## Features
- 📝 Step-by-step process guides
- ✅ Interactive task checklists
- 💾 Local progress saving
- 📊 Progress tracking
- 🔄 Multiple process support
- 📱 Responsive design
- ✨ Markdown support with:
- Checkboxes
- Mermaid diagrams
- GFM (GitHub Flavored Markdown)
## Technology Stack
- React
- TailwindCSS
- Unified/Remark for Markdown processing
- LocalStorage for progress persistence
- Lucide React for icons
## Getting Started
### Prerequisites
- Node.js (v14 or higher)
- npm or yarn
### Installation
1. Clone the repository:
```bash
git clone [repository-url]
```
2. Install dependencies:
```bash
npm install
```
3. Start the development server:
```bash
npm run dev
```
## Usage
### Adding New Processes
Create new process definitions in the `processes` directory.
### Markdown Support
The app supports enhanced markdown with:
- Standard markdown formatting
- Mermaid diagrams
## Local Storage
The application uses browser local storage to maintain:
- Process completion status
- Task checkboxes state
- Storage notice dismissal
## Deploying
The application can be deployed to a static web site:
- S3 + Cloudfront
- GitHub or GitLab pages