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

Add link guide #1276

Merged
merged 1 commit into from
Aug 7, 2024
Merged

Add link guide #1276

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,29 @@ The script behind the scenes does several steps:
1. The current references from `docs` folder are being removed and generated references in `.tmp` folder are moved to the `docs`.
1. The code examples are being injected. The code examples from the `examples` folder are being put into corresponding files in the references folder.

# Creating links

Tip: To enable autocomplete in VSCode open `docs` folder in the workspace.

- Use only absolute paths, which is easier to maintain when moving files around or requires global search and replace.
- Use the `.mdx` extension.
- Start paths with `/`.
- Don't use `/docs` as root path.

Don't:

`[Attributes](developer/attributes.mdx)`

`[Attributes](/developer/attributes)`

`[Attributes](../../attributes)`

`[Attributes](/docs/developer/attributes)`

Do:

`[Attributes](/developer/attributes.mdx)`

# Search

Saleor Docs are using Algolia DocSearch for the website search.
Expand Down