Docskit

Overview

Docskit is a web app that allows users to create simple and beautiful documentation using Markdown directly in their browser. It makes use of Supabase for authentication and storage, providing a seamless user experience. With a focus on ease of use and aesthetics, Docskit aims to enhance the documentation creation process.

Features

• Create documentation using Markdown in your browser
• Utilize Supabase for authentication and database storage
• Built with Remix + Typescript for enhanced website development
• Apply Tailwind CSS for efficient and customizable styling
• Access unstyled and accessible UI components with Headless UI
• Benefit from the Supabase Javascript client library, Supabase Remix Auth Helper, and Superkey for easy integration and user authentication
• Use Monaco Editor for React to incorporate the feature-rich monaco-editor into your applications
• Implement markdown rendering with React-Markdown
• Leverage React-Hook-Form for performant and flexible forms with validation
• Add smooth animations using Framer Motion
• Access a wide range of popular icons with React-Icons

Installation

To run Docskit locally, follow these steps:

1. Clone or fork the repository.
2. Install dependencies using your preferred package manager.
3. Create a .env file in the root directory with the following content:

SUPABASE_URL=<your Supabase project URL>
SUPABASE_ANON_KEY=<your Supabase project API key>

4. To configure Supabase and GitHub OAuth:

• Supabase:

  • Create a new database.
  • Go to Authentication -> Providers and activate GitHub.
  • Go to SQL Editor -> click on New Query and run the provided query from db.sql.
  • Go to Settings -> API and copy the Project URL (set it as SUPABASE_URL in the .env file) and the Project API keys (set it as SUPABASE_ANON_KEY in the .env file).

• GitHub OAuth:

  • Create a new GitHub OAuth app.
  • Copy the Client ID and paste it into GitHub Secret.
  • Generate a new client secret and paste it into GitHub Key.

5. Start the Remix development server.

6. Open up http://localhost:3000 in your browser.

Summary

Docskit is a web app that simplifies the process of creating beautiful documentation using Markdown. It leverages Supabase for authentication and storage, as well as various libraries and frameworks like Remix + Typescript, Tailwind CSS, and React-Markdown. Docskit offers a range of features, including user authentication, customizable styling, accessible UI components, and animation capabilities. With a straightforward installation process and a focus on enhancing the documentation creation experience, Docskit is a useful tool for developers and content creators.