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.

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

Markdown linting #129

Merged
merged 7 commits into from
Jan 8, 2024
Merged

Markdown linting #129

merged 7 commits into from
Jan 8, 2024

Conversation

cnivolle
Copy link
Member

@cnivolle cnivolle commented Jan 5, 2024

Checklist

⚠️ If changes affect GitHub Action files

  • I have added tests to cover my changes : link

Pull request type

Please check the type of change your PR introduces:

  • Documentation content changes
  • Bugfix on the site
  • Build related changes
  • Other (please describe):

Description

Adding a linting for markdown file and some documentation content refactor to match the new documentation guidelines (use of callouts, tables, filetree etc.)

Why is this needed?

It's been added for the following reasons:

  • removing legacy HTML with unsafe behavior
  • better edition and contribution experience
  • better reading experience
  • better and conventional markdown syntax

Reviewes

Who should review these changes? @juliamrch

@juliamrch
Copy link
Collaborator

Note: closing and reopening to trigger an updated deployment, don't panic

Copy link

github-actions bot commented Jan 8, 2024

Deployment has finished 👁️👄👁️ Your app is available here

Copy link

github-actions bot commented Jan 8, 2024

🚀 Your app has been updated and is available here

content/doc/contribute/shortcodes.md Show resolved Hide resolved
content/doc/contribute/shortcodes.md Show resolved Hide resolved
@juliamrch juliamrch merged commit 20a5a6b into CleverCloud:main Jan 8, 2024
3 checks passed
Copy link

github-actions bot commented Jan 8, 2024

Your review app has been deleted 👋

juliamrch added a commit that referenced this pull request Jan 22, 2024
* chore: linting config files

* chore: linting the content directory

* chore: linting the static directory

* chore: glossary is now a TOML file

* chore: css for better tables after linting

* chore: updated readme for linting

---------

Co-authored-by: Julia March <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants