From 949c2f8a80d2de8f1028100cbebfb840eb288201 Mon Sep 17 00:00:00 2001 From: Pedro Cuenca Date: Thu, 8 Sep 2022 08:54:55 +0200 Subject: [PATCH] Small fixes to README --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 23bac6a18..219375c2e 100644 --- a/README.md +++ b/README.md @@ -122,10 +122,10 @@ automarically adds a link to its documentation: \[\`XXXClass\`\] or \[\`function function to be in the main package. If you want to create a link to some internal class or function, you need to -provide its path. For instance, in the Transformers documentation \[\`file_utils.ModelOutput\`\] will create a link to the documnetation of `ModelOutput`. This link will have `file_utils.ModelOutput` in the description. To get rid of the path and only keep the name of the object you are +provide its path. For instance, in the Transformers documentation \[\`file_utils.ModelOutput\`\] will create a link to the documentation of `ModelOutput`. This link will have `file_utils.ModelOutput` in the description. To get rid of the path and only keep the name of the object you are linking to in the description, add a ~: \[\`~file_utils.ModelOutput\`\] will generate a link with `ModelOutput` in the description. -The same works for methods so you can either use \[\`XXXClass.method\`\] or \[~\`XXXClass.method\`\]. +The same works for methods so you can either use \[\`XXXClass.method\`\] or \[\`~XXXClass.method\`\]. Multi-line code blocks can be useful for displaying examples. They are done between two lines of three backticks as usual in Markdown: @@ -410,4 +410,4 @@ npm run dev -- --open ``` 4. Start developing. See svelte files in `doc-builder/kit/src/lib` for reference. The flow should be: 1. Create a svelte component in `doc-builder/kit/src/lib` - 2. Import it & test it in `doc-builder/kit/src/routes/index.mdx` \ No newline at end of file + 2. Import it & test it in `doc-builder/kit/src/routes/index.mdx`