jaywcjlove / rdoc

⚛️📄🚀 Fast static site generator for React, Just write Markdown file. @react-doc

Hi, I'm Kenny, Fullstack developer from Shanghai, China.

Weibo • Twitter • E-Mail • Sponsor

✦ My macOS application ✦

More Repositories ...

Handbook	Homepage	Stars	Last Commit	Downloads	Version
awesome-mac	#homepage
reference	#homepage
handbook	#homepage
mysql-tutorial	#homepage
awesome-uikit	#homepage
docker-tutorial	#homepage
nginx-tutorial	#homepage
golang-tutorial	#homepage
swiftui-example	#homepage
shell-tutorial	#homepage
git-tips	#homepage
regexp-example	#homepage
package.json	#homepage
swift-tutorial	#homepage
c-tutorial	#homepage
awesome-chatgpt	#homepage
github-actions	#homepage
react-native	#homepage
react-components-awesome	#homepage
html-tutorial	#homepage
Github Actions	Homepage	Stars	Last Commit	Downloads	Version
changelog-generator	#homepage
github-action-contributors	#homepage
github-action-package	#homepage
generated-badges	#homepage
markdown-to-html	#homepage
create-tag-action	#homepage
github-action-modify-file-content	#homepage
github-action-read-file	#homepage
action-ejs	#homepage
Rehype Plugins	Homepage	Stars	Last Commit	Downloads	Version
rehype-attr	#homepage
rehype-rewrite	#homepage
rehype-video	#homepage
remark-github-blockquote-alert	#homepage
rehype-ignore	#homepage
SwiftUI Plugins	Homepage	Stars	Last Commit	Downloads	Version
swiftui-markdown	#homepage
swiftui-texteditor	#homepage
swiftui-searchfield	#homepage
Other Project	Homepage	Stars	Last Commit	Downloads	Version
linux-command	#homepage
hotkeys-js	#homepage
github-rank	#homepage
iNotify	#homepage
oscnews	#homepage
vim-web	#homepage
DevHub	#homepage
validator.js	#homepage
svgtofont	#homepage
mocker-api	#homepage
FED	#homepage
store.js	#homepage
react-hotkeys	#homepage
translater.js	#homepage
idoc	#homepage
amac	-
sgo	#homepage
tools	#homepage
cookie.js	#homepage
rdoc	#homepage
wxmp	#homepage
sb	#homepage
icongo	#homepage
tsbb	#homepage
onlinenetwork	-
magic-input	#homepage
colors-cli	#homepage
wcj	#homepage
loading-cli	#homepage
markdown-to-html-cli	#homepage
dev-site	#homepage
websocket	-
date.js	#homepage
rust-cn-document-for-docker	#homepage
stylus-px2rem	#homepage
jaywcjlove	-
rollup-demo	-
nginx-editor	#homepage
html-to-markdown-cli	#homepage
google	#homepage
code-image	#homepage
console-emojis	#homepage
jaywcjlove.github.io	#homepage
parcel-plugin-markdown-string	#homepage
refs-cli	#homepage
webpack-react-demo	-
AutoPrefixCSS	-
local-ip-url	#homepage
webpack-plugin-manifest	-
table-of-general-standard-chinese-characters	#homepage
coverage-badges-cli	#homepage
dark-mode	#homepage
bannerjs	#homepage
react-native-doc	-
regex-mate	#homepage
TextSoundSaver	#homepage
MDEditor	#homepage
image2uri	#homepage
logo	#homepage
react-native-typescript-example	-
code-example	#homepage
docs	#homepage
generate-password	#homepage
react-dynamic-loadable	-
time-passage	#homepage
compile-less	#homepage
gitke	-
IconizeFolder	#homepage
outdatedbrowser	-
chinese-numerals	#homepage
colors-named-decimal	#homepage
debugger-terminator	-
ResumeRevise	#homepage
typenexus	#homepage
chmod-cli	#homepage
doc-static	-
ejs-cli	#homepage
recursive-readdir-files	#homepage
auto-config-loader	#homepage
auto-gitee-mirror	-
BlankTab	-
colors-named	#homepage
pml	-
reader-stat	#homepage
rollup-plugin-less	#homepage
url-encode	#homepage
whereis	#homepage
create-custom-symbols	#homepage
hsl-matcher	#homepage
markdown-style	#homepage
uglify-js-export	#homepage
zh-hans.react.dev-for-docker	-
colors-named-hex	#homepage
path-templater	#homepage
hello-world-npm	-
map-manager-report-location	-
palette-genius	#homepage
swiftui-tutorial	#homepage
symbol-scribe	#homepage

Web Tool • SVG Icon Search • WXMP • CodeImage • Quick Reference • json-viewer • npm-unpkg • run-web • keycode-info • ui-color • nginx-editor • linux-command • github-rank • dev-site • logo • regexp-example • URL Decoder/Encoder

rdoc's Issues

发布到github

貌似是卡在这里了,一直在等待.
不一定是rdoc的问题,有什么建议吗@jaywcjlove

in windows

C:\Users\wellorange\Desktop\document\my-project\node_modules\create-spare-webpack-plugin\index.js:36
filePathItem = filePathItem.replace(process.cwd() + PATH.sep, '').replace(new RegExp(PATH.sep, 'g'), sep);
^

SyntaxError: Invalid regular expression: //: \ at end of pattern
at new RegExp ()
at filemds.forEach (C:\Users\wellorange\Desktop\document\my-project\node_modules\create-spare-webpack-plugin\index.js:36:85)
at Array.forEach ()
at Compiler.compiler.plugin (C:\Users\wellorange\Desktop\document\my-project\node_modules\create-spare-webpack-plugin\index.js:33:15)
at Compiler.applyPluginsAsyncSeries (C:\Users\wellorange\Desktop\document\my-project\node_modules\tapable\lib\Tapable.js:206:13)
at compilation.seal.err (C:\Users\wellorange\Desktop\document\my-project\node_modules\webpack\lib\Compiler.js:507:11)
at Compilation.applyPluginsAsyncSeries (C:\Users\wellorange\Desktop\document\my-project\node_modules\tapable\lib\Tapable.js:195:46)
at self.applyPluginsAsync.err (C:\Users\wellorange\Desktop\document\my-project\node_modules\webpack\lib\Compilation.js:680:19)
at Compilation.applyPluginsAsyncSeries (C:\Users\wellorange\Desktop\document\my-project\node_modules\tapable\lib\Tapable.js:195:46)
at self.applyPluginsAsync.err (C:\Users\wellorange\Desktop\document\my-project\node_modules\webpack\lib\Compilation.js:671:11)
at Compilation.applyPluginsAsyncSeries (C:\Users\wellorange\Desktop\document\my-project\node_modules\tapable\lib\Tapable.js:195:46)
at self.applyPluginsAsync.err (C:\Users\wellorange\Desktop\document\my-project\node_modules\webpack\lib\Compilation.js:666:10)
at Compilation.applyPluginsAsyncSeries (C:\Users\wellorange\Desktop\document\my-project\node_modules\tapable\lib\Tapable.js:195:46)
at sealPart2 (C:\Users\wellorange\Desktop\document\my-project\node_modules\webpack\lib\Compilation.js:662:9)
at Compilation.applyPluginsAsyncSeries (C:\Users\wellorange\Desktop\document\my-project\node_modules\tapable\lib\Tapable.js:195:46)
at Compilation.seal (C:\Users\wellorange\Desktop\document\my-project\node_modules\webpack\lib\Compilation.js:605:8)
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! [email protected] start: rdoc -d home,introduce,faq,about,github --clean
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the [email protected] start script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR! C:\Users\wellorange\AppData\Roaming\npm-cache_logs\2018-01-22T03_18_06_238Z-debug.log

C:\Users\wellorange\Desktop\document\my-project>

如何使用ssh发布到服务器上

我怎么使用publish或deploy命令将生成的文件通过ssh发布到服务器上

解析出错

运行 rdoc init my-project 时，程序为什么会解析我的本地文件？

【功能】侧边栏及树形导航支持折叠收起

hi：
感觉RDOC非常不错，可以用来写接口文档和博客。但是在内容比较多时希望左侧的树形菜单支持折叠收起功能，全部展示出来显示不完且优点杂乱。另外就是侧边栏如果能够支持整体收起隐藏就更好了。

Module not found: Can't resolve './indexLayout.less'

我的运行环境
inux 4.14.0-deepin2-amd64 #1 SMP PREEMPT Deepin 4.14.12-2 (2018-01-06) x86_64 GNU/Linux
node 9.8.0

rdoc -d about

/usr/local/lib/node_modules/rdoc/theme/default/layout/IndexLayout.js
Module not found: Can't resolve './indexLayout.less' in '/usr/local/lib/node_modules/rdoc/theme/default/layout

npm start

Module not found: Can't resolve './indexLayout.less' in '/media/oeli/doc/node_modules/rdoc/theme/default/layout'

Html Webpack Plugin:
TypeError: $export is not a function

• index.html:1880 Object../node_modules/core-js/library/modules/es6.object.define-property.js
  [spiderdoc]/[rdoc]/theme/default/index.html:1880:1

• index.html:639 webpack_require
  [spiderdoc]/[rdoc]/theme/default/index.html:639:30

• index.html:49 fn
  [spiderdoc]/[rdoc]/theme/default/index.html:49:20

• index.html:894 Object../node_modules/core-js/library/fn/object/define-property.js
  [spiderdoc]/[rdoc]/theme/default/index.html:894:1

• index.html:639 webpack_require
  [spiderdoc]/[rdoc]/theme/default/index.html:639:30

• index.html:49 fn
  [spiderdoc]/[rdoc]/theme/default/index.html:49:20

• index.html:725 Object../node_modules/babel-runtime/core-js/object/define-property.js
  [spiderdoc]/[rdoc]/theme/default/index.html:725:27

• index.html:639 webpack_require
  [spiderdoc]/[rdoc]/theme/default/index.html:639:30

• index.html:49 fn
  [spiderdoc]/[rdoc]/theme/default/index.html:49:20

• index.html:1462 Object../node_modules/core-js/library/modules/_object-dp.js
  [spiderdoc]/[rdoc]/theme/default/index.html:1462:21

• From previous event:

• index.js:110 Compiler.
  [spiderdoc]/[html-webpack-plugin]/index.js:110:8

• Tapable.js:206 Compiler.applyPluginsAsyncSeries
  [spiderdoc]/[tapable]/lib/Tapable.js:206:13

• Compiler.js:354 Compiler.emitAssets
  [spiderdoc]/[webpack]/lib/Compiler.js:354:8

• Compiler.js:58 onCompiled
  [spiderdoc]/[webpack]/lib/Compiler.js:58:19

• Compiler.js:510 applyPluginsAsync.err
  [spiderdoc]/[webpack]/lib/Compiler.js:510:14

• Tapable.js:202 next
  [spiderdoc]/[tapable]/lib/Tapable.js:202:11

• CachePlugin.js:78 Compiler.
  [spiderdoc]/[webpack]/lib/CachePlugin.js:78:5

• Tapable.js:204 next
  [spiderdoc]/[tapable]/lib/Tapable.js:204:14

• index.js:46 Compiler.compiler.plugin
  [spiderdoc]/[create-spare-webpack-plugin]/index.js:46:7

• Tapable.js:206 Compiler.applyPluginsAsyncSeries
  [spiderdoc]/[tapable]/lib/Tapable.js:206:13

• Compiler.js:507 compilation.seal.err
  [spiderdoc]/[webpack]/lib/Compiler.js:507:11

• Tapable.js:195 Compilation.applyPluginsAsyncSeries
  [spiderdoc]/[tapable]/lib/Tapable.js:195:46

• Compilation.js:677 applyPluginsAsync.err
  [spiderdoc]/[webpack]/lib/Compilation.js:677:19

• Tapable.js:195 Compilation.applyPluginsAsyncSeries
  [spiderdoc]/[tapable]/lib/Tapable.js:195:46

• Compilation.js:668 applyPluginsAsync.err
  [spiderdoc]/[webpack]/lib/Compilation.js:668:11

• Tapable.js:195 Compilation.applyPluginsAsyncSeries
  [spiderdoc]/[tapable]/lib/Tapable.js:195:46

• Compilation.js:663 applyPluginsAsync.err
  [spiderdoc]/[webpack]/lib/Compilation.js:663:10

• Tapable.js:195 Compilation.applyPluginsAsyncSeries
  [spiderdoc]/[tapable]/lib/Tapable.js:195:46

• Compilation.js:659 applyPluginsAsyncSeries
  [spiderdoc]/[webpack]/lib/Compilation.js:659:9

output 选项不可用，看了webpack配置，buildPath是写死了，没有用到命令行里的参数

编译运行报错

"rdoc": "1.8.x"

如何使md支持代码运行，文档需要带运行示例的

如题

router.js 报错

C:/Users/Administrator/AppData/Roaming/npm/node_modules/rdoc/src/web/Router.js
Module parse failed: Unexpected token (12:43)
You may need an appropriate loader to handle this file type.
|   if (!arr || arr.length === 0) return false;
|   const index = arr.filter(item => item.name === 'README.md' && item.mdconf);
|   if (index && index.length > 0) props = { ...index[0] };
|   return props;
| }

关于目前在用的几个问题

1. 版权更换，版权修改能不能像更新icon的方式一样设置简单一些，我看您说可以通过更换主题的方式修改，但是这个对于非react的专业学员来说操作确实麻烦了一点。
2. 虽然是doc，但是目前手机端的流量也蛮大，我发现目前对于手机端的适配比较不友好，请问是否有计划对手机端的显示做一些优化，目前使用iPhone发现竖屏的情况下，左侧的导航栏占据了一大部分的屏幕，右边的doc内容被压缩得很窄，读起来很费劲。

感谢倾听，望回复！

不支持图片吗?

看了下.rdoc-dist文件夹下 图片没有生成

init project error in windows

C:\Users\Administrator\AppData\Roaming\npm\node_modules\rdoc\node_modules\create
-spare-webpack-plugin\index.js:26
const { dir, ...otherOtions } = directoryTrees;
^^^

SyntaxError: Unexpected token ...
at createScript (vm.js:74:10)
at Object.runInThisContext (vm.js:116:10)
at Module._compile (module.js:533:28)
at Object.Module._extensions..js (module.js:580:10)
at Module.load (module.js:503:32)
at tryModuleLoad (module.js:466:12)
at Function.Module._load (module.js:458:3)
at Module.require (module.js:513:17)
at require (internal/module.js:11:18)
at Object. (C:\Users\Administrator\AppData\Roaming\npm\node_modul
es\rdoc\src\conf\webpack.config.dev.js:7:34)
at Module._compile (module.js:569:30)
at Object.Module._extensions..js (module.js:580:10)
at Module.load (module.js:503:32)
at tryModuleLoad (module.js:466:12)
at Function.Module._load (module.js:458:3)
at Module.require (module.js:513:17)

执行 npm start 控制台提示ip是 0.0.0.0

DONE  Compiled successfully in 327ms                                                                           11:19:34


Dev Server Listening at http://0.0.0.0:5858

然后浏览器自动打开的也是 http://0.0.0.0:5858

你好。想问下关于在码云上部署出错的问题。

http://yumenawei.gitee.io/blog/
码云平台的pages后面会带上一个目录。
但是rdoc的js文件是跟在网址的后面的，
求解怎么设置下。谢啦

Cannot find module 'uglifyjs-webpack-plugin'

执行rdoc init my-project时遇到这个错误信息
本机环境：macos、node9.11.1、npm 5.8.0

请问怎么配置搜索框

如题

自己扩展支持IE8，会有哪些难点，能简单列举下么

顺带问下，这个库的版权协议是什么呢

copyright怎么更换

底部copyright的内容怎么替换？

npm run build uglify报错

ERROR in js/vendor.28c0ef80.js from UglifyJs
Unexpected token: keyword «const» [./node_modules/@babel/polyfill/lib/index.js:6,0][js/vendor.28c0ef80.js:12996,2]

也许 src/conf/path.js -> getExcludeFoldersRegExp 需要改一下。

运行 start 的时候出错

TypeError: $export is not a function

  - index.html:1880 Object../node_modules/core-js/library/modules/es6.object.define-property.js
    [blog]/[rdoc]/theme/default/index.html:1880:1

  - index.html:639 __webpack_require__
    [blog]/[rdoc]/theme/default/index.html:639:30

  - index.html:49 fn
    [blog]/[rdoc]/theme/default/index.html:49:20

  - index.html:894 Object../node_modules/core-js/library/fn/object/define-property.js
    [blog]/[rdoc]/theme/default/index.html:894:1

  - index.html:639 __webpack_require__
    [blog]/[rdoc]/theme/default/index.html:639:30

  - index.html:49 fn
    [blog]/[rdoc]/theme/default/index.html:49:20

  - index.html:725 Object../node_modules/babel-runtime/core-js/object/define-property.js
    [blog]/[rdoc]/theme/default/index.html:725:27

  - index.html:639 __webpack_require__
    [blog]/[rdoc]/theme/default/index.html:639:30

  - index.html:49 fn
    [blog]/[rdoc]/theme/default/index.html:49:20

  - index.html:1462 Object../node_modules/core-js/library/modules/_object-dp.js
    [blog]/[rdoc]/theme/default/index.html:1462:21

  - From previous event:

  - index.js:110 Compiler.<anonymous>
    [blog]/[html-webpack-plugin]/index.js:110:8

  - Tapable.js:206 Compiler.applyPluginsAsyncSeries
    [blog]/[tapable]/lib/Tapable.js:206:13

  - Compiler.js:354 Compiler.emitAssets
    [blog]/[webpack]/lib/Compiler.js:354:8

  - Compiler.js:58 onCompiled
    [blog]/[webpack]/lib/Compiler.js:58:19

  - Compiler.js:510 applyPluginsAsync.err
    [blog]/[webpack]/lib/Compiler.js:510:14

  - Tapable.js:202 next
    [blog]/[tapable]/lib/Tapable.js:202:11

  - CachePlugin.js:78 Compiler.<anonymous>
    [blog]/[webpack]/lib/CachePlugin.js:78:5

  - Tapable.js:204 next
    [blog]/[tapable]/lib/Tapable.js:204:14

  - index.js:46 Compiler.compiler.plugin
    [blog]/[create-spare-webpack-plugin]/index.js:46:7

  - Tapable.js:206 Compiler.applyPluginsAsyncSeries
    [blog]/[tapable]/lib/Tapable.js:206:13

  - Compiler.js:507 compilation.seal.err
    [blog]/[webpack]/lib/Compiler.js:507:11

  - Tapable.js:195 Compilation.applyPluginsAsyncSeries
    [blog]/[tapable]/lib/Tapable.js:195:46

  - Compilation.js:677 applyPluginsAsync.err
    [blog]/[webpack]/lib/Compilation.js:677:19

  - Tapable.js:195 Compilation.applyPluginsAsyncSeries
    [blog]/[tapable]/lib/Tapable.js:195:46

  - Compilation.js:668 applyPluginsAsync.err
    [blog]/[webpack]/lib/Compilation.js:668:11

  - Tapable.js:195 Compilation.applyPluginsAsyncSeries
    [blog]/[tapable]/lib/Tapable.js:195:46

  - Compilation.js:663 applyPluginsAsync.err
    [blog]/[webpack]/lib/Compilation.js:663:10

  - Tapable.js:195 Compilation.applyPluginsAsyncSeries
    [blog]/[tapable]/lib/Tapable.js:195:46

  - Compilation.js:659 applyPluginsAsyncSeries
    [blog]/[webpack]/lib/Compilation.js:659:9

  - From previous event:

  - index.js:55 Compiler.<anonymous>
    [blog]/[html-webpack-plugin]/index.js:55:8

  - Tapable.js:293 Compiler.applyPluginsParallel
    [blog]/[tapable]/lib/Tapable.js:293:14

  - Compiler.js:499 applyPluginsAsync.err
    [blog]/[webpack]/lib/Compiler.js:499:9

  - Tapable.js:195 Compiler.applyPluginsAsyncSeries
    [blog]/[tapable]/lib/Tapable.js:195:46

  - Compiler.js:492 Compiler.compile
    [blog]/[webpack]/lib/Compiler.js:492:8

  - Compiler.js:83 compiler.applyPluginsAsync.err
    [blog]/[webpack]/lib/Compiler.js:83:18

  - Tapable.js:202 next
    [blog]/[tapable]/lib/Tapable.js:202:11

  - Shared.js:161 Compiler.compilerInvalid
    [blog]/[webpack-dev-middleware]/lib/Shared.js:161:5

  - Tapable.js:204 next
    [blog]/[tapable]/lib/Tapable.js:204:14

  - CachePlugin.js:48 Compiler.compiler.plugin
    [blog]/[webpack]/lib/CachePlugin.js:48:5

  - Tapable.js:206 Compiler.applyPluginsAsyncSeries
    [blog]/[tapable]/lib/Tapable.js:206:13

  - Compiler.js:48 Watching._go
    [blog]/[webpack]/lib/Compiler.js:48:17

  - Compiler.js:142 Watching.invalidate
    [blog]/[webpack]/lib/Compiler.js:142:9

  - Compiler.js:123 watcher.compiler.watchFileSystem.watch
    [blog]/[webpack]/lib/Compiler.js:123:9

  - NodeWatchFileSystem.js:45 Watchpack.watcher.once
    [blog]/[webpack]/lib/node/NodeWatchFileSystem.js:45:4

  - watchpack.js:142 Watchpack._onTimeout
    [blog]/[watchpack]/lib/watchpack.js:142:7

build的问题

貌似build次数越多,输出文件就越多.

md文件里使用<font>标签不生效

我想在一段文字里对个别词语做字体的突出，在RDOC里应该怎样做

就不能发个图吗?

就不能发个图吗?效果是什么样的?
readme写的不合格哈.