96af36bf1f
|
||
|---|---|---|
| .. | ||
| client | ||
| example-docs | ||
| scripts | ||
| src | ||
| tests | ||
| .eslintrc | ||
| .prettierrc.js | ||
| .wp-env.json | ||
| README.md | ||
| composer.json | ||
| composer.lock | ||
| package.json | ||
| phpunit.xml | ||
| tsconfig.json | ||
| webpack.config.js | ||
| woocommerce-docs.php | ||
README.md
WooCommerce Docs Plugin
This is a work-in-progress plugin with the desired goal of consolidating documentation from various sources into Wordpress posts.
Although this is called WooCommerce Docs, it should be able to be used with any Wordpress site and a manifest conforming to the data structure (TBD) to create Wordpress posts from Markdown content.
Development
Set up the monorepo as usual, now from this directory run pnpm build to build the webpack assets.
This plugin creates a top level menu called "WooCommerce Docs" that you can navigate to once
you've mounted the plugin in your development environment.
You can use monorepo utils from the repo root to generate new manifests:
pnpm utils md-docs create ./plugins/woocommerce-docs/example-docs woodocs --outputFilePath ./plugins/woocommerce-docs/scripts/manifest.json
To load the manifest as a source in the plugin go to the plugin page and add a manifest with url:
http://your-local-wp-host/wp-content/plugins/woocommerce-docs/scripts/manifest.json
Please note that if you're hosting the file within Docker, that localhost will not work as the host for your file because that's reserved for localhost within the container. You'll need to use the IP address of your machine instead or on Mac OS you can use the Docker DNS name host.docker.internal.