🌿 Simpesys
Simpesys

Simpesys

  1. Getting Started
  2. Design Principles
    1. Document-Centric Design
    2. High Connectivity
    3. Application Layer Separation
    4. Narrow and Deep Modules
  3. Subpages
    1. Other Languages
    2. Others
  4. License
  5. External Links
  6. Backlinks

Simpesys is a Markdown file–based documentation build tool that also serves as a complete documentation system for digital gardens.

Simpesys models the entire document system as a tree. However, since documents can cross-reference each other, the hierarchical model forms a tree while the reference model can become a connected directed graph with circuits. This structure allows Simpesys to maintain a simple overall document structure while managing complex reference relationships between documents. Upon initialization, Simpesys reads the designated root Markdown document. Starting from the root document, it parses internal link syntax within the content and repeatedly reads connected documents to build the complete document tree. Simpesys constructs this document tree and provides APIs for working with it.

The name “Simpesys” is a portmanteau of “Simonpedia” and “system”, pronounced /sɪmˈpesɪs/.

Getting Started

Simpesys provides a package for the Deno runtime.

$ deno add jsr:@simpesys/core

A Simpesys project has the following directory structure:

my-garden/
├── deno.json
├── app/
│   └── main.ts
└── docs/
    ├── index.md
    └── 404.md

For detailed instructions on building a digital garden with Simpesys, see the Getting Started document.

Design Principles

Document-Centric Design

Simpesys focuses exclusively on documents. Each Markdown file in the document directory represents a single document. Every document is identified by a unique relative path from the root document and can have either a flat or hierarchical structure. Simpesys treats all internal links connected to the root document as documents. The Page Not Found document, required to represent missing documents, is not treated exceptionally but exists as a regular subdocument of the root.

High Connectivity

Simpesys emphasizes connectivity between documents. The core of a digital garden lies in the high connectivity between documents. Shortening the distance from one document to another is a goal that should be continuously pursued while maintaining a digital garden. As documents accumulate, carving out personal paths through the vast forest becomes increasingly important, and users should be able to naturally gain new inspiration while strolling along the paths they have created. A digital garden is not a wiki for preserving objective knowledge. The moment a digital garden becomes a personal wiki, it degrades into a Wikipedia without collective intelligence.

Application Layer Separation

Simpesys itself is not a tool for creating static sites or web applications. The goal of Simpesys is to structure a document system and provide APIs for working with that structure. While Simpesys converts Markdown to HTML during initialization, this is less about building an application and more about providing an intermediate layer for representing documents in a standardized way. Application implementation is the user’s responsibility, and Simpesys has no dependencies for application implementation.

Narrow and Deep Modules

The module interfaces Simpesys provides to users should be narrow, and the depth of functionality should be deep. Simpesys exposes only essential APIs, and users who want to customize internal behavior can only do so through predefined option values. Simpesys follows “convention over configuration” by providing sensible defaults for all configuration options.

Subpages

Other Languages

Others

License

Simpesys is distributed under the GNU General Public License v3.0.