Home
Softono

Xie

Open source MIT JavaScript
31
Stars
1
Forks
1
Issues
0
Watchers
10 months
Last Commit

 About Xie

A single HTML notebook, perfect for minimalists.

Platforms

Web Self-hosted

Languages

JavaScript

Need Help Installing Xie?

We provide expert installation service for this software. Our team will install, configure, and secure Xie on your server. plans start at just $30.

xie

A 9KB (3KB gzip) single HTML notebook, perfect for minimalists.

A simple, self-contained application with Markdown support. Write, edit, and manage your notes or articles directly in the browser, and save the result as a static HTML file.

Features

  • Create, edit, and delete articles in your browser
  • Supports a wide range of Markdown syntax (headings, lists, code, links, images, etc.)
  • Save your entire wiki as a single HTML file for easy backup or sharing
  • Minimal, clean interface with custom styles

Getting Started

Prerequisites

  • Node.js (v16 or above recommended)

Installation

  1. Clone this repository or download the source code.
  2. Install dependencies:
    npm install
    

Development

Start the development server:

npm run dev

Visit the local address shown in the terminal (usually http://localhost:5173).

Build

To build the project for production:

npm run build

The output will be in the dist/ directory.

Project Structure

├── index.html         # Main HTML file
├── package.json       # Project metadata and scripts
├── vite.config.ts     # Vite configuration
├── src/
│   ├── main.js        # App entry point, UI logic
│   ├── helper.js      # DOM helpers and save/edit/delete logic
│   └── md.js          # Markdown parser
├── styles/
│   ├── custom.css     # Custom styles
│   └── neat.css       # Additional styles

License

MIT