diff options
| author | bptato <nincsnevem662@gmail.com> | 2024-06-04 19:42:45 +0200 |
|---|---|---|
| committer | bptato <nincsnevem662@gmail.com> | 2024-06-04 19:43:03 +0200 |
| commit | 8e1baaedfdcc3f99e2b69b2927d4237dd4c63e1d (patch) | |
| tree | 71c8413865fb249104901587ad64a439e963739a | |
| parent | f5cccfe0655f7266e88cc537f9572926ebdef570 (diff) | |
| download | chawan-8e1baaedfdcc3f99e2b69b2927d4237dd4c63e1d.tar.gz | |
Update docs, todo
| -rw-r--r-- | README.md | 2 | ||||
| -rw-r--r-- | doc/manual.md | 15 | ||||
| -rw-r--r-- | todo | 2 |
3 files changed, 16 insertions, 3 deletions
diff --git a/README.md b/README.md index 85b45924..ed64e14e 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Include Chame in your project using either Nimble or as a git submodule. ``` -requires "https://git.sr.ht/~bptato/chame" +requires "chame" ``` Then, check the [documentation](https://chawan.net/doc/chame/) for a diff --git a/doc/manual.md b/doc/manual.md index 56ea3b9f..a1a1b1ff 100644 --- a/doc/manual.md +++ b/doc/manual.md @@ -7,6 +7,21 @@ they give consumers less control than htmlparser. Here we describe both APIs. +## Table of Contents + +* [Basic concepts](#basic-concepts) + - [Standards](#standards) + - [String interning](#string-interning) + - [String validation](#string-validation) +* [High-level API (minidom, minidom_cs)](#high-level-api-minidom-minidom_cs) +* [Low-level API (htmlparser)](#low-level-api-htmlparser) + - [Functions and procedures](#functions-and-procedures) + * [initHTML5Parser](#inithtml5parser) + * [parseChunk](#parsechunk) + * [finish](#finish) + - [Generic parameters](#generic-parameters) +* [Example](#example) + ## Basic concepts ### Standards diff --git a/todo b/todo index 05a627a8..80ad5420 100644 --- a/todo +++ b/todo @@ -1,6 +1,4 @@ interface: * reduce use of getNamespace (maybe store ns on the stack of open elements?) etc: -* turn test1 into a serializer module -* optimize tokenizer consume stuff (e.g. eatStr...) * add getElementById and some more basic stuff to minidom |