Comments (3)
@rahulsprajapati we might need to fix https://github.com/mAAdhaTTah/wordpress-github-sync if it doesn't support Gutenberg.
I am not sure how Gutenberg's HTML comment will work with Markdown.
So for time being, we might need to disable Gutenberg on handbook
CPT. We can use https://wordpress.org/plugins/gutenberg-ramp/ for this part (if needed).
from docs.
@rahul286 Are you indicating that the docs should in fact be standard markdown that is then parsed and generated into WordPress posts/pages with appropriate formatting? If so, this is great news.
from docs.
@brianjking Yep. The intention is to not only use plain & simple markdown but also use Jekyll and front-matter https://jekyllrb.com/docs/front-matter/
Now the WordPress is used as a presentation layer. This way we don't need to design or maintain a separate Jekyll theme.
Besides, we can use some WordPress features such as SEO plugins, related posts/docs, and more.
With WordPress, we will be able to allow logged in users to subscribe to pages they are interested in and receive changes to those pages via email!
Now, we started with a good plugin https://github.com/mAAdhaTTah/wordpress-github-sync which takes care of data sync part between markdown files here and WordPress post content nicely. It's just the plugin we depend on isn't tested with Gutenberg.
Our devs couldn't fix yet as we are clueless as of how to preserve Gutenberg comments on markdown sync. But if that turns out to be a blocker, we will remove Gutenberg for the documentation part.
Documentation being simple pages, may not require Gutenberg.
from docs.
Related Issues (20)
- Rough outline to doc automatation HOT 1
- [Docs Plugin] Register CPTs HOT 1
- Commands docs HOT 2
- Handbook CPT HOT 1
- Document why ee shell is needed
- Write documentation on testing
- Improve shared vs global services doc
- [Doc] How to verify if full page cache is working
- [Doc] Add guide as how community can help add more OS support
- Create step by step doc on how to install EasyEngine on mac HOT 6
- How to update Nginx configuration
- Write docs on how to setup CI/CD for WP site HOT 1
- Document frequently asked questions
- Add missing info in global file system structure
- Documentation on how to disable mysql binlog
- Solution for Cannot create/start proxy container HOT 1
- Documentation for setting up MYSQLTuner HOT 1
- Documentation for enabling MYSQL Slow Query Log
- Where are the docs for /handbook/configure-sftp-on-ee4-server/
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 docs.