Skip to content

Commit 3ba43dd

Browse files
committed
update readme
1 parent 4d8389d commit 3ba43dd

1 file changed

Lines changed: 5 additions & 26 deletions

File tree

README.md

Lines changed: 5 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -168,30 +168,9 @@ console.log(typst);
168168
</script>
169169
```
170170

171+
## Examples
171172

172-
#### Using the library - Locally
173-
174-
```typescript
175-
import { markdown2typst } from './src/markdown2typst';
176-
177-
const markdown = `
178-
# My Document
179-
180-
This is a paragraph with **bold** and *italic* text.
181-
182-
## Features
183-
184-
- Item 1
185-
- Item 2
186-
`;
187-
188-
const typst = markdown2typst(markdown);
189-
console.log(typst);
190-
```
191-
192-
### Advanced usage
193-
194-
See the [Examples](/examples/README.md) page for advanced examples on how to use the library.
173+
See the [Examples](/examples/README.md) page for basic and advanced examples on how to use the library and all the features it supports.
195174

196175
## Internal architecture
197176
Check the [Architecture](./ARCHITECTURE.md) doc for getting a better understanding of how the library works under the hood.
@@ -216,14 +195,14 @@ Built thanks to the following open-source projects:
216195
- [tex2typst](https://github.com/qwinsi/tex2typst) - Typst conversion for LaTeX equations
217196
- [js-yaml](https://github.com/nodeca/js-yaml) - YAML parser
218197

219-
This code is mainly based on the code by zhaoyiqun (@cosformula on GitHub), more specifically in his [markdownToTypst.ts](https://github.com/cosformula/mdxport/blob/main/src/lib/pipeline/markdownToTypst.ts) custom conversion library (renderer to Typst code) built for his open source project [MDXport](https://mdxport.com).
198+
This code was initially based on the code by zhaoyiqun (@cosformula on GitHub), more specifically in his [markdownToTypst.ts](https://github.com/cosformula/mdxport/blob/main/src/lib/pipeline/markdownToTypst.ts) custom conversion library (renderer to Typst code) built for his open source project [MDXport](https://mdxport.com).
220199

221200
## Roadmap
222201

223202
- [X] Finish an initial working version
224203
- [X] Add frontmatter support and also allow to pass the keys as custom options of the main function
225-
- [ ] Publish to npm
226-
- [ ] Add a comprehensive test suite
204+
- [X] Publish to npm
205+
- [X] Add a comprehensive test suite
227206
- [ ] Add CLI tool
228207
- [ ] Support custom templates
229208
- [ ] Support more Markdown extensions/flavors/specs

0 commit comments

Comments
 (0)