Skip to content

Clarify Markdown link formatting and line break usage in user guide #74

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

Draft
KentMossback wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −1
Draft

Clarify Markdown link formatting and line break usage in user guide #74

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
6 changes: 5 additions & 1 deletion docs/PxWebApi/documentation/user-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1340,11 +1340,15 @@ They are then separated by quotation marks and commas. See e.g.

> <https://data.ssb.no/api/pxwebapi/v2/tables/12880/metadata?lang=en>.

In PxWeb all HTML will be rendered as text only. You can include links by using Mardown. We support two formats:
In PxWeb all HTML will be rendered as text only. You can include links by using Markdown. We support two formats:

- `[My-link-text](https://my-url-here.com)`
- `<https://my-url-here.com>`

To create a line break in a note, end a line with two spaces, and then type return, apply the same formatting style for any repeated line breaks or new paragraphs.

The system guarantees support for links and line breaks (written in Markdown). Other formatting features should not be used at this time.

## Language

Most of the endpoints take a `lang` parameter specifying which language the response
Expand Down