/phodit

Phodal's markdown/ebook editor with MicroFrontend & Web Components

Primary LanguageTypeScriptMIT LicenseMIT

Phodit - 私人定制的 Markdown 编辑器

Build Status GitHub package.json version Markdown Improve

一个基于 Electron 的私人定制的 Markdown 编辑器

Screenshots

Screenshots

Features

  • 标题折叠
  • 支持所见所得模式
  • 编写时图片
  • 语法高亮
  • 集成 Terminal
  • markdown 实时预览
  • 工程管理
  • 支持使用 Git 来编写 markdown 项目
  • 支持全屏
  • 语法高亮
  • 编辑器主题切换
  • 导出支持（pdf、docx）
  • 右键选择搜索: Google, Baidu, WIKI, Zhihu, Github
  • phodal.com 相关文章搜索（通过 "《"开始搜索）
  • 微信公众号排版支持
  • 支持 Slide 编写(by reveal.js)
  • .md 和 .markdown 文件关联打开

Tech Stack

Phodit 是一个使用微前端架构开发的 Electron 应用：

  • React.js -> TreeView
  • Angular -> Rename box
  • Stencil.js + Web Components -> Terminal Header

相应的技术栈有：

  • SimpleMDE + CodeMirror -> Editor
  • xterm -> Terminal
  • marked -> Markdown Parser
  • highlight.js -> Code Highlight
  • lunr -> search engine
  • Reveal.js -> Slide

Setup

requirements: node.js

Submodule

git submodule init
git submodule update

npm install --python=python2.7

yarn install 
yarn build:app

setup nodejieba in Windows

Components

Name Path Stacks
editor ./editor SimpleMDE
header ./component/header Stencil.js
interact ./component/interact Angular
tree-view ./component/tree-view React

Setup && build

yarn install
yarn build

FAQ

Node.js issues

Question:

App threw an error during load
Error: The module '/Users/phodal/repractise/phodit/node_modules/nodejieba/build/Release/nodejieba.node'
was compiled against a different Node.js version using
NODE_MODULE_VERSION 57. This version of Node.js requires
NODE_MODULE_VERSION 64. Please try re-compiling or re-installing
the module (for instance, using `npm rebuild` or `npm install`).
    at process.module.(anonymous function) [as dlopen] (ELECTRON_ASAR.js:160:31)
    at Object.Module._extensions..node (internal/modules/cjs/loader.js:722:18)
    at Object.module.(anonymous function) [as .node] (ELECTRON_ASAR.js:160:31)
    at Module.load (internal/modules/cjs/loader.js:602:32)
    at tryModuleLoad (internal/modules/cjs/loader.js:541:12)
    at Function.Module._load (internal/modules/cjs/loader.js:533:3)
    at Module.require (internal/modules/cjs/loader.js:640:17)
    at require (internal/modules/cjs/helpers.js:20:18)
    at Object.<anonymous> (/Users/phodal/repractise/phodit/node_modules/nodejieba/index.js:1:172)
    at Object.<anonymous> (/Users/phodal/repractise/phodit/node_modules/nodejieba/index.js:58:3)

Solution: electron-rebuild

Run:

./node_modules/.bin/electron-rebuild -p -t "dev,prod,optional"

License

Phodal's Idea

© 2018~2021 A Phodal Huang's Idea. This code is distributed under the MIT license. See LICENSE in this directory.