{"id":47728181,"url":"https://github.com/samrocketman/mkdocs-live-wysiwyg-plugin","last_synced_at":"2026-04-02T21:00:59.639Z","repository":{"id":341248559,"uuid":"1169438854","full_name":"samrocketman/mkdocs-live-wysiwyg-plugin","owner":"samrocketman","description":"WYSIWYG docs editor for Mkdocs Material themed docs.  A content editing experience.","archived":false,"fork":false,"pushed_at":"2026-03-27T05:04:02.000Z","size":8134,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-03-27T17:40:26.011Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/samrocketman.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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-02-28T17:31:36.000Z","updated_at":"2026-03-27T05:04:04.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/samrocketman/mkdocs-live-wysiwyg-plugin","commit_stats":null,"previous_names":["samrocketman/mkdocs-live-wysiwyg-plugin"],"tags_count":76,"template":false,"template_full_name":null,"purl":"pkg:github/samrocketman/mkdocs-live-wysiwyg-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samrocketman%2Fmkdocs-live-wysiwyg-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samrocketman%2Fmkdocs-live-wysiwyg-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samrocketman%2Fmkdocs-live-wysiwyg-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samrocketman%2Fmkdocs-live-wysiwyg-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/samrocketman","download_url":"https://codeload.github.com/samrocketman/mkdocs-live-wysiwyg-plugin/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samrocketman%2Fmkdocs-live-wysiwyg-plugin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31316099,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-02T12:59:32.332Z","status":"ssl_error","status_checked_at":"2026-04-02T12:54:48.875Z","response_time":89,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":[],"created_at":"2026-04-02T21:00:40.628Z","updated_at":"2026-04-02T21:00:59.626Z","avatar_url":"https://github.com/samrocketman.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mkdocs-live-wysiwyg-plugin\n\n[![PyPI - Version](https://img.shields.io/pypi/v/mkdocs-live-wysiwyg-plugin)](https://pypi.org/project/mkdocs-live-wysiwyg-plugin/)\n[![VS Code Marketplace](https://img.shields.io/visual-studio-marketplace/v/mkdocs-wysiwyg.mkdocs-wysiwyg?label=vscode)](https://marketplace.visualstudio.com/items?itemName=mkdocs-wysiwyg.mkdocs-wysiwyg)\n[![Open VSX](https://img.shields.io/open-vsx/v/mkdocs-wysiwyg/mkdocs-wysiwyg)](https://open-vsx.org/extension/mkdocs-wysiwyg/mkdocs-wysiwyg)\n\nAn all-in-one editor for GitHub and mkdocs documentation.  Available from an\nextension store above or from GitHub release.  Alternately available as a simple\nshell script.\n\nRight click on `mkdocs.yml` to start the mkdocs server and start editing files directly from the mkdocs interface.\n\n\u003cdetails class=\"note\"\u003e\n\u003csummary\u003e📝 A small CLI tutorial (click to expand)\u003c/summary\u003e\n\n1. Add [techdocs-preview.sh][1] to your `$PATH`.\n2. Edit documentation across your projects.\n\n## Try it out\n\nRun `./techdocs-preview.sh` from this repository to view the documentation for this repository.\n\nFor a general tutorial, you can run the following command in an empty directory.\n\n```bash\ntechdocs-preview.sh init\n```\n\n- `init` will initialized mkdocs documentation for any project.\n- The tutorial itself provides a starting point for docs as well as teaching material.  About a 15 mins read.\n\nI modify GitHub documentation for this repository with the following command.\n\n```bash\ntechdocs-preview.sh -c -a docs\n```\n\n\u003c/details\u003e\n\n\n## Features\n\nA WYSIWYG (What-You-See-Is-What-You-Get) editor for editing `mkdocs` documentation.\n\n- 🌈✨ Author quality of life features\n  - 👁-👁 Focus mode with collapsible nav sidebar, editing tools, and table of contents.\n  - 📝 Non-destructive editing is a top priority.  Minimal  `git diff` .\n  - 🧜 Mermaid diagram editor with a unique feature: text on diagrams can be clicked to auto-select matching mermaid text.  Enables fast editing of existing diagrams.\n  - 🗂️ File management: reorder files, content migrations, dead link scanning (for broken internal or external links), preview and manage images.  Refactors links to documents and intra-document links when headings are renamed.\n  - 🔗 A URL pasted onto selected text creates a markdown link.  Headings can be copied to create intra-document links.  Hold Ctrl key to open links with a click.\n  - 🍹🤌 Unified editor actions for WYSIWYG and Markdown modes (i.e. switching modes).\n    - 🗡 Loss-less undo/redo history with a UI to access full redo history.  Switching modes has shared undo history.\n    - 🐁 Cursor location memory: switching modes keeps cursor and scroll area in same document location.\n    - 🛰 Text selections are preserved when the author switches modes.\n- 💪 Mkdocs/backage rendering features\n  - ✅ Toggle-able checklists (task lists): `- [ ]` and `- [x]` .\n  - ✅ YAML frontmatter preserved when editing and switching modes.\n  - ✅ MkDocs admonitions (`!!! note`, `!!! warning`, etc.) with settings gear for type, collapsible, placement, and more.\n  - ✅ Markdown link styles preserved (inline, reference, shortcut).\n  - ✅ Code blocks with WYSIWYG editable titles, language selector, and auto-indent settings.\n  - ✅ Mermaid diagram editing with an embedded live editor (full-screen overlay).\n  - ✅ Tables with contextual toolbar: insert/delete rows and columns, column alignment, and formatting settings.\n  - ✅ Image dialog with autocomplete from the docs tree.\n  - ✅ Emoji shortcode completion and full emoji picker.\n  - ✅ Automated content migration to mkdocs-nav-weight.\n- ℹ️ Other noteworthy features\n  - ✅ Auto-conversions: inline typing of markdown syntax creates formatted text.\n  - ✅ Balanced ASCII table formatting with configurable max width and per-table overrides.\n  - ✅ Context-sensitive help panel (Ctrl+?).  Not as good as clippy 📎.\n  - ✅ No external JavaScript; all assets are bundled locally within the mkdocs plugin.\n\nThe following is an annotated screenshot after running `techdocs-preview.sh init`.\n\n![Screen Shot](docs/images/focus-busy.png)\n\n## MkDocs Theme Support\n\nOnly the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme is officially supported. Admonition styling and icons rely on Material theme CSS. Other themes may work but have not been tested.\n\n**No breaking changes** to Material theme compatibility are allowed.\n\nSupport for admonition syntax (e.g. `!!! note`, `!!! warning`, etc.). Admonitions render as they would when the site is built by mkdocs.  Collapsible admonitions (`??? type`) and HTML details tags (`!!! details`) are also supported.\n\n## Attributions\n\nThis plugin incorporates or depends on the following works:\n\n| Component                  | Author                     | License | Link                       |\n| -------------------------- | -------------------------- | ------- | -------------------------- |\n| **@celsowm/markdown-wysiwyg** (WYSIWYG editor) | Celso Fontes               | MIT     | [GitHub](https://github.com/celsowm/markdown-wysiwyg) · [npm][2] |\n| **marked** (Markdown parser) | Christopher Jeffrey, MarkedJS | MIT     | [GitHub](https://github.com/markedjs/marked) · [marked.js.org](https://marked.js.org) |\n| **js-yaml** (YAML parser)  | Vitaly Puzrin              | MIT     | [GitHub](https://github.com/nodeca/js-yaml) |\n| **mermaid** (Diagram renderer) | Knut Sveidqvist            | MIT     | [GitHub](https://github.com/mermaid-js/mermaid) · [mermaid.js.org](https://mermaid.js.org) |\n| **mermaid-live-editor** (Diagram editor) | Knut Sveidqvist            | MIT     | [GitHub](https://github.com/mermaid-js/mermaid-live-editor) |\n| **mkdocs-live-edit-plugin** (required dependency) | Eddy Luten                 | MIT     | [GitHub][3]                |\n\nAll listed components are distributed under the MIT License. See each project's repository for full license text.\n\nAll vendored JavaScript, CSS, and application builds are bundled locally in `mkdocs_live_wysiwyg_plugin/vendor/` — no external JavaScript or CSS is loaded at runtime. See [`vendor/README.md`](mkdocs_live_wysiwyg_plugin/vendor/README.md) for exact versions and license files.\n\n[1]: https://raw.githubusercontent.com/samrocketman/mkdocs-live-wysiwyg-plugin/refs/heads/main/techdocs-preview.sh\n[2]: https://www.npmjs.com/package/@celsowm/markdown-wysiwyg\n[3]: https://github.com/eddyluten/mkdocs-live-edit-plugin\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamrocketman%2Fmkdocs-live-wysiwyg-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsamrocketman%2Fmkdocs-live-wysiwyg-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamrocketman%2Fmkdocs-live-wysiwyg-plugin/lists"}