{"id":51941246,"url":"https://github.com/piyushxcoder/folklore","last_synced_at":"2026-07-28T19:01:02.080Z","repository":{"id":372479277,"uuid":"1307649229","full_name":"PiyushXCoder/folklore","owner":"PiyushXCoder","description":"A viewer for superlore docs.","archived":false,"fork":false,"pushed_at":"2026-07-21T14:02:02.000Z","size":3529,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2026-07-21T14:12:52.194Z","etag":null,"topics":["docs"],"latest_commit_sha":null,"homepage":"https://piyushxcoder.github.io/folklore/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PiyushXCoder.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-07-21T11:55:41.000Z","updated_at":"2026-07-21T14:05:19.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/PiyushXCoder/folklore","commit_stats":null,"previous_names":["piyushxcoder/folklore"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/PiyushXCoder/folklore","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PiyushXCoder%2Ffolklore","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PiyushXCoder%2Ffolklore/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PiyushXCoder%2Ffolklore/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PiyushXCoder%2Ffolklore/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PiyushXCoder","download_url":"https://codeload.github.com/PiyushXCoder/folklore/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PiyushXCoder%2Ffolklore/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":36003882,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-07-20T02:08:10.276Z","status":"online","status_checked_at":"2026-07-28T02:00:06.341Z","response_time":109,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docs"],"created_at":"2026-07-28T19:01:00.949Z","updated_at":"2026-07-28T19:01:02.070Z","avatar_url":"https://github.com/PiyushXCoder.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"src/assets/banner.png\" alt=\"folklore — a doc viewer for superlore files\" /\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003e\n  \u003cimg src=\"src/assets/accordion.svg\" width=\"28\" alt=\"\" align=\"center\" /\u003e\n  folklore\n\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003eA viewer for \u003ca href=\"https://superlore.vercel.app\"\u003esuperlore\u003c/a\u003e docs — desktop app and web app, one codebase.\u003c/p\u003e\n\n## What is superlore?\n\n[superlore](https://superlore.vercel.app) is a content model for docs that are readable by both humans and AI agents from the same source. A superlore doc is MDX plus a typed frontmatter schema and a library of \"dual-representation\" components — cards, timelines, boards, entity cards, tables, and an interactive Canvas — each of which renders a polished page for people *and* serializes to a typed knowledge graph an agent can query over MCP. One file, two audiences, never out of sync.\n\nThe atom of superlore is a single `.mdx` file: no project, no deploy, no build step required to read one.\n\n## What is folklore?\n\nfolklore is that reading experience, taken out of the browser. Open a `.superlore` bundle or a plain `.mdx` file and it renders using superlore's own official runtime — the exact same components, Canvas, and syntax highlighting as the hosted docs site and the [online Viewer](https://superlore.vercel.app/viewer) — just running natively, with your own files, in a window instead of a tab.\n\n## Features\n\n- **Open `.superlore` bundles and plain `.mdx` files.** A `.superlore` file is a zip bundle — the doc, its images, comment threads, and metadata all in one — for when a doc needs to travel with its assets. A bare `.mdx` just opens straight up.\n- **Live-reload.** Edit the file in your own editor and the view updates automatically — no manual refresh, no re-opening. Works on both desktop (a real filesystem watch) and the web (polling a File System Access handle in Chromium-based browsers).\n- **Desktop and web from one codebase.** Ships as a native Tauri app (Linux/macOS/Windows) with a native open dialog, drag-and-drop, and \"open with\" / CLI launching — or as a plain static web app you can host anywhere, with the same file picker and drag-and-drop experience in the browser.\n- **Word-style reading layout.** A centered, paginated content column with a left-hand outline sidebar (built from the doc's own headings) — closer to a document than a docs-site sidebar-and-hero layout.\n- **7 color schemes, 14 accents.** Catppuccin's four flavors (Latte, Frappé, Macchiato, Mocha) plus Darcula, VS Code, and Adwaita, each with the full accent palette — switch live from Settings, no restart.\n- **A flat, consistent design language.** 2px border radius everywhere in the app's own chrome, while still letting superlore's Canvas diagrams render their real shapes (circles, diamonds, pills) undistorted.\n\n## Installing\n\n- **Arch Linux**: [`folklore-bin`](https://aur.archlinux.org/packages/folklore-bin) on the AUR — `yay -S folklore-bin` (or your favorite AUR helper).\n- **Other Linux / Windows / macOS**: grab an installer from the [latest release](https://github.com/PiyushXCoder/folklore/releases/latest) (`.deb`, `.rpm`, `.AppImage`, `.msi`, `.exe`, `.dmg`).\n- **Web**: [piyushxcoder.github.io/folklore](https://piyushxcoder.github.io/folklore/) — no install, runs in the browser.\n\n## Getting started\n\n```bash\npnpm install\n\n# web dev server\npnpm dev\n\n# desktop dev (wraps the same dev server in a native window)\npnpm tauri dev\n```\n\n### Building\n\n```bash\n# web — static output in dist/\npnpm build\n\n# desktop installer for your current OS\npnpm tauri build\n```\n\n\u003e **Linux AppImage note:** if bundling fails with `failed to run linuxdeploy`, run with `NO_STRIP=1 pnpm tauri build`. linuxdeploy's bundled `strip` can't parse the ELF `.relr.dyn` section some modern system libraries emit — this skips its (redundant) strip pass. See `CLAUDE.md` for details.\n\n### Releasing\n\nPushing a `v*.*.*` tag (or running the *Release* workflow manually from the Actions tab) builds installers for Linux, macOS (Intel + Apple Silicon), and Windows, and publishes them as a draft GitHub Release. The web build deploys to GitHub Pages separately (its own *Deploy web app to GitHub Pages* workflow), on every push to `master` — kept apart from tag releases because GitHub Pages' environment protection only allows deploys from the default branch, not tags.\n\n## Project layout\n\nSee `CLAUDE.md` for the full architecture rundown, and `progress.md` for a running log of what's built and what's next.\n\n## License\n\nMIT © [Piyush Raj](mailto:piyushxcoder@gamil.com) — see [LICENSE](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpiyushxcoder%2Ffolklore","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpiyushxcoder%2Ffolklore","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpiyushxcoder%2Ffolklore/lists"}