Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Submit the Interactive Code Block to the WordPress Plugin directory #62

Closed
adamziel opened this issue Jun 2, 2023 · 2 comments
Closed

Submit the Interactive Code Block to the WordPress Plugin directory #62

adamziel opened this issue Jun 2, 2023 · 2 comments
Labels
Enhancement New feature or request interactive code block Meta

Comments

@adamziel
Copy link
Collaborator

adamziel commented Jun 2, 2023

The Interactive Code Block merged in #168. The initial release works and could already help developers write tutorials if it was available in the plugin directory. Let's submit it there!
This was referenced Jun 2, 2023
Closed
Open
@adamziel
Copy link
Collaborator Author

adamziel commented Jun 9, 2023

CleanShot 2023-06-09 at 14 53 08@2x

Let's wait for the review!

@adamziel adamziel mentioned this issue Jun 9, 2023
Merged
adamziel added a commit that referenced this issue Jun 9, 2023
@adamziel
Prepare Interactive Code Block for plugin directory submission (#77)
4efa240 
## What?

Needed for #62

* Adds the README file
* Adds the LICENSE file
* Bundles both of them
* Restricts the supported PHP version to 7.4 to keep the bundle size
below 10MB (WP.org limit)

## Testing Instructions

Submit a plugin to the directory...? 😆
@adamziel
Copy link
Collaborator Author

https://wordpress.org/plugins/interactive-code-block/

johnhooks pushed a commit to johnhooks/playground-tools that referenced this issue Oct 11, 2024
@adamziel
API docs generator (WordPress#62)
d3bdbb3 
## Overview

Adds a API documentation pipeline:

1. Build TypeScript types using `tsc`
2. Generate an API model and store it as JSON using `api-extractor` from the [TSDoc toolkit](https://tsdoc.org/)
3. Generate markdown files from the API model using a **highly** customized version of TSDoc's api-extractor I put in the  `typescript-reference-doc-generator` package.
4. Generate a pretty HTML page from the markdown using Vitepress (it's likely to change to another tool)

I'll merge the documentation itself in another PR.

Technically, you run these commands:

```
npm run build:api-docs
npm run dev:docs:server
```

And get this page:

<img width="1125" alt="CleanShot 2022-11-04 at 22 11 57@2x" src="https://user-images.githubusercontent.com/205419/200110405-b4bc130f-50cd-432d-a09d-93a6f10e05d8.png">

<img width="1134" alt="CleanShot 2022-11-04 at 22 11 41@2x" src="https://user-images.githubusercontent.com/205419/200110401-22740c94-cd5b-42e6-96c6-e77724a10908.png">

Follows up on WordPress/wordpress-playground#61
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Enhancement New feature or request interactive code block Meta
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@adamziel