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

Properly escape tags in documentation #6

Closed
molant opened this issue Apr 21, 2021 · 1 comment
Closed

Properly escape tags in documentation #6

molant opened this issue Apr 21, 2021 · 1 comment
Assignees
@molant
Labels
🪲 bug Something isn't working

Comments

@molant
Copy link
Contributor

molant commented Apr 21, 2021

Docusuarus has some problems when there's content like:

The tag

This does not happen if it is in a code block. Another alternative is to "escape" it like this:

The tag

But that /> renders and it does not look OK.

Need to find a way to solve this.

You can see them, need to figure out how to do this properly but might take a bit of time.
OK if I file a separate issue and address later?

Originally posted by @molant in #3 (comment)
@molant molant added the 🪲 bug Something isn't working label Apr 21, 2021
@molant molant self-assigned this Apr 21, 2021
@molant molant mentioned this issue Apr 21, 2021
Merged
molant added a commit that referenced this issue Apr 21, 2021
@molant
build: pre-build script
971b3fa 
The pre-build scripts does the following:
1. Downloads the documentation from electron/electron and data/blog
   from electron/electronjs.org
2. Moves the files to the right folders based on the contents of
   `docs-reorg.json`
3. Add frontmatter to each file
4. Fixes internal links and multiline image titles
5. Generates the sidebar using the folder structure

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Fix #6
Ref: Solves parts of #2
@molant
Copy link
Contributor Author

molant commented Apr 21, 2021

#3 has a fix for this

@molant molant closed this as completed in 972a54e Apr 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@molant molant

Labels
🪲 bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@molant