Code Monkey home page Code Monkey logo

picidaejs's Introduction

Picidae

NPM version NPM Downloads

Picidae is a document generator which has gentle experience. 💨
As shown below

Picidae Video

Why?

There are a lot of document generator now, why I choose Picidae?

Picidae Hexo GitBook
SPA ❌(pjpx)
Transformer

Why I consider VuePress had supportted transformer partially?
VuePress has markdown transformer by markdown-it. However, Picidae has more than it which includes browser transformer. the browser transformer could do lots of magic, eg. react-render

Where use it

Starter

npm install picidae -g

picidae init [blog]
cd [blog]
# install Globally
picidae use picidae-theme-grass
# or install Locally
npm install picidae picidae-theme-grass --save

picidae start
open http://localhost:8989
# build the site for deploy
picidae build

# install Globally
picidae use picidae-commander-gh-pages
# or install Locally
npm install picidae-commander-gh-pages --save

# ```
# // append the configuration.
# commanders: [
#   '[email protected]:[username]/[username].github.io.git&branch=master&remote=origin'
# ]
# ```
picidae gh-pages # deploy the static assets to the github

Theme

We can write customized Theme using React.
Default Theme

Commander

We can write customized Commander using commander.
Commander: New

Transformer

We can write customized Transformer which is divided into NodeTransformer & BrowserTransformer
As shown below

** mdast -> remark transformer -> markdown -> markdown transfromer -> markdown -> html -> html transformer -> html -> browser transformer (converter) -> html-to-react **

picidaejs's People

Contributors

imcuttle avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

picidaejs's Issues

Picidae V3

  1. test

  2. lerna

  3. routesMapper

  4. ...

  5. 扩展能力更强,支持对内部运行机制修改的plugin

  6. 之前的picidae的能力都需要继承下来

  7. 依赖库的更新

  8. transform流程需要修改,去掉 html 中间数据

Better error thrown

  1. Compare the expect config object's shape (theme/picidae, like webpack) and the actual
  2. the error of transformer, Need to print better(which transformer), and don't have side effect.

win7系统上路径解析出错

Choose one: is this a 🐛 bug report or 🙋 feature request?
bug report

🎛 Configuration (.babelrc, package.json, cli command)

{
  'your': { 'config': 'here' }
}

🤔 Expected Behavior

😯 Current Behavior

run picidae start

💁 Possible Solution

🔦 Context

a lot of warnings, and the pages can't be rendered properly!
194d43fd44fd454e8ee217718c40e1f8

🌍 Your Environment

Software Version(s)
Picidae 2.1.6
Node 8.9.0
npm/Yarn 5.5.1
Operating System win7

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.