diff --git a/.gitignore b/.gitignore index 2fd44f1b..30a6512f 100644 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,5 @@ n2y.egg-info/ build/ dist/ .vscode +venv +requirements.txt \ No newline at end of file diff --git a/README.md b/README.md index 15942c4b..70eb41b7 100644 --- a/README.md +++ b/README.md @@ -99,27 +99,36 @@ Here are the default block classes that can be extended: | Class Name | Noteworthy Behavior | | --- | --- | -| BookmarkBlock | | +| BookmarkBlock | Converts visual bookmark into plain text link in markdown, using the caption as the link text. | +| BreadcrumbBlock | These blocks are ignored | | BulletedListItemBlock | | | CalloutBlock | The content of the callout block is extracted, but the emoji and background color are ignored. | -| ChildPageBlock | | -| FencedCodeBlock | | +| ChildDatabaseBlock | These blocks are ignored | +| ChildPageBlock | These blocks are ignored | +| ColumnBlock | | +| ColumnListBlock | Converts into a table where each column is such. | | DividerBlock | | +| EmbedBlock | These blocks are ignored | +| EquationBlock | Converted to "display math" using LaTeX; see the [pandoc](https://pandoc.org/MANUAL.html#math) documentation. | +| FencedCodeBlock | | +| FileBlock | Acts the same way as the ImageBlock, except that in the documents it only ever shows the URL. | | HeadingOneBlock | | | HeadingTwoBlock | | | HeadingThreeBlock | | | ImageBlock | It uses the URL for external images, but downloads uploaded images to the `MEDIA_ROOT` and replaces the path with a relative url based off of `MEDIA_URL`. The "caption" is used for the alt text. | -| FileBlock | Acts the same way as the ImageBlock, except that in the documents it only ever shows the URL. | +| LinkToPageBlock | Transcribes the block into a plain text link | | NumberedListItemBlock | | | ParagraphBlock | | +| PdfBlock | Acts the same way as the Image block | | QuoteBlock | | -| EquationBlock | Converted to "display math" using LaTeX; see the [pandoc](https://pandoc.org/MANUAL.html#math) documentation. | -| TableBlock | | | RowBlock | | +| SyncedBlock | Transcribe the contents of the synced block at the time it was constructed | +| TableBlock | | +| TableOfContentsBlock | These blocks are ignored | +| TemplateBlock | These blocks are ignored | | ToDoItemBlock | | | ToggleBlock | Convert the toggles into a bulleted list. | -| ColumnBlock | | -| ColumnListBlock | Columns are flattened and displayed sequentially. | +| VideoBlock | Acts the same way as the Image block | Most of the Notion blocks can generate their pandoc AST from _only_ their own data. The one exception is the list item blocks; pandoc, unlike Notion, has an encompassing node in the AST for the entire list. The `ListItemBlock.list_to_pandoc` class method is responsible for generating this top-level node.