Comments (8)
Theming roadmap (v0.8)
-
docpress-base
will be renamed todocpress-html
. (#143) This is a Metalsmith plugin responsible for building basic the HTML structure. -
docpress-html
will be made to only generate HTML... no CSS or JavaScript. This will greatly simplify docpress-html, which is very overloaded right now. -
The CSS/JS parts will be extracted to
docpress-theme-base
. This allows us to manage the complexity build tools (stylus, postcss, browserify) in just one module.Docpress will now use a pipeline of:
docpress-core
(parses .md files) →docpress-html
(generates .html) →docpress-theme-base
(adds .css and .js).
Future themes will replace docpress-theme-base
in that pipeline. There will be tools in docpress-theme-base to allow you to build themes on top of it easily (ie, reuse the same stylus/browserify pipeline to build your own themes).
from docpress.
Might be nice to have a docpress init
command that sets up a docpress.json
with some nice defaults, docs folder, and gh-pages deploy setup? Maybe post 1.0 though.
Also docpress -h
doesn't work, it should.
from docpress.
...you can even build that as a docpress-init
module, which docpress will just delegate to later.
from docpress.
Oh, thats not a bad idea. It's actually pretty easy. If you guys wanna take a stab at it, go ahead.
npm install --save-dev docpress
mkdir -p docs
cat << EOF
# Table of Contents
* [Project name here](../README.md)
EOF > docs/README.md
echo '{ "github": "github/url" }' > docs/docpress.json
# add { scripts: { docs: "docpress build" } } to package.json
# add { scripts: { "docs:watch": "docpress" } } to package.json
gh-pages integration is harder though (it has some manual steps), so I'd hold off on that.
from docpress.
I'd love if we could switch stylus --> postcss and pug --> to something html like (handlebars?). Makes contributing so much simpler, and understanding the code for building themes.
from docpress.
stylus to postcss-cssnext + postcss-easy-import? yes, that's certainly possible. the lack of var ?= value
would be a shame (it's a way to make variables easily overridable), but I think we'll survive.
pug to something else? that'd be hard. the menu generation relies on pug's recursive mixins, something not easily doable in handlebars. mustache, maybe.
from docpress.
Maybe swig, not really set on a specific preprocessor, but it should be something that keeps the html in it's normal state.
from docpress.
We should probably also lock into Node 6.9-lts for v1.0
from docpress.
Related Issues (20)
- Docpress serve trips up on symlinked folder. HOT 3
- Update docpress-core deps to fix security issue. HOT 3
- How to insert an image? HOT 6
- Error: README.md: Unknown reference '/docs/components.md' HOT 2
- Mobile: 'Next' overlay shadows button HOT 1
- Mobile: Links should scroll down to content instead of index table.
- isso instead of disqus .. HOT 1
- CRASH: TypeError: Cannot set property 'contents' of undefined
- Set livereload-port for docker watch to work
- Unknown reference '../README.md' HOT 1
- TypeError: Cannot read property 'contents' of undefined HOT 4
- Set htmlhref language to site HOT 1
- docpress --help vs docpress -h
- docpress init HOT 1
- Live code editing HOT 1
- subsites not included (windows) HOT 14
- Build failed - did you forget to load/include a language module? HOT 6
- Code syntax dark theme?
- RTL Support
- Version 9 of Highlight.js has reached EOL and is no longer supported
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from docpress.