apex-ruby 1.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/README.md +119 -0
- data/apex-ruby.gemspec +31 -0
- data/ext/apex_ext/apex_ext.c +215 -0
- data/ext/apex_ext/apex_src/BENCHMARK.md +32 -0
- data/ext/apex_ext/apex_src/BENCHMARK_COMPARISON.md +67 -0
- data/ext/apex_ext/apex_src/CHANGELOG.md +2454 -0
- data/ext/apex_ext/apex_src/CMakeLists.txt +454 -0
- data/ext/apex_ext/apex_src/Dockerfile.linux-build +15 -0
- data/ext/apex_ext/apex_src/Formula/apex.rb +38 -0
- data/ext/apex_ext/apex_src/Info.plist.in +27 -0
- data/ext/apex_ext/apex_src/LICENSE +21 -0
- data/ext/apex_ext/apex_src/Package.swift +160 -0
- data/ext/apex_ext/apex_src/PackageSupport/README.md +17 -0
- data/ext/apex_ext/apex_src/PackageSupport/cmark-gfm/cmark-gfm_export.h +20 -0
- data/ext/apex_ext/apex_src/PackageSupport/cmark-gfm/cmark-gfm_version.h +14 -0
- data/ext/apex_ext/apex_src/PackageSupport/cmark-gfm/cmark_gfm_spm_stub.c +4 -0
- data/ext/apex_ext/apex_src/PackageSupport/cmark-gfm/config.h +41 -0
- data/ext/apex_ext/apex_src/README.md +452 -0
- data/ext/apex_ext/apex_src/VERSION +1 -0
- data/ext/apex_ext/apex_src/apex-header-2-rb@2x.webp +0 -0
- data/ext/apex_ext/apex_src/apex-plugins.json.example +20 -0
- data/ext/apex_ext/apex_src/apex.pc.in +11 -0
- data/ext/apex_ext/apex_src/cli/main.c +2720 -0
- data/ext/apex_ext/apex_src/debug_test.sh +22 -0
- data/ext/apex_ext/apex_src/docs/API_REFERENCE.md +451 -0
- data/ext/apex_ext/apex_src/docs/ARCHITECTURE.md +166 -0
- data/ext/apex_ext/apex_src/docs/CMARK_INTEGRATION.md +220 -0
- data/ext/apex_ext/apex_src/docs/CRITICMARKUP.md +501 -0
- data/ext/apex_ext/apex_src/docs/DEBUGGING.md +73 -0
- data/ext/apex_ext/apex_src/docs/FINAL_STATUS.md +391 -0
- data/ext/apex_ext/apex_src/docs/FINAL_STATUS_UPDATE.md +237 -0
- data/ext/apex_ext/apex_src/docs/FUTURE_FEATURES.md +456 -0
- data/ext/apex_ext/apex_src/docs/IAL_FEATURES.md +210 -0
- data/ext/apex_ext/apex_src/docs/IAL_STATUS.md +344 -0
- data/ext/apex_ext/apex_src/docs/INTEGRATION_EXAMPLE.m +144 -0
- data/ext/apex_ext/apex_src/docs/LIMITATIONS_RESOLVED.md +278 -0
- data/ext/apex_ext/apex_src/docs/OUTPUT_MODES.md +321 -0
- data/ext/apex_ext/apex_src/docs/PROGRESS.md +167 -0
- data/ext/apex_ext/apex_src/docs/STANDALONE_FEATURE.md +174 -0
- data/ext/apex_ext/apex_src/docs/TABLE_SPANS_STATUS.md +243 -0
- data/ext/apex_ext/apex_src/docs/TEST_COVERAGE.md +316 -0
- data/ext/apex_ext/apex_src/docs/USER_GUIDE.md +803 -0
- data/ext/apex_ext/apex_src/docs/WIKI_LINKS_ISSUE.md +91 -0
- data/ext/apex_ext/apex_src/documentation/README.md +160 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex Command Line Options.cheatsheet.txt +365 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Info.plist +24 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/C-API.html +1737 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Citations.html +1420 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Command-Line-Options.html +3574 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Configuration.html +1603 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Credits.html +910 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Examples.html +1168 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Getting-Started.html +1003 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Header-IDs.html +1308 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Home.html +1078 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Inline-Attribute-Lists.html +1622 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Installation.html +1168 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Limitations-and-Roadmap.html +1698 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Metadata-Transforms.html +1531 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Modes.html +1980 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Multi-File-Documents.html +1368 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Pandoc-Integration.html +1151 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Plugins.html +2861 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Syntax.html +3981 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Troubleshooting.html +1454 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Usage.html +1200 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Xcode-Integration.html +2066 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/docSet.dsidx +0 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/optimizedIndex.dsidx +0 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/tempOptimizedIndex.dsidx +0 -0
- data/ext/apex_ext/apex_src/documentation/docsets/ApexCLI.docset/Contents/Info.plist +22 -0
- data/ext/apex_ext/apex_src/documentation/docsets/ApexCLI.docset/Contents/Resources/Documents/cheatset_resources/Open_Sans.woff +0 -0
- data/ext/apex_ext/apex_src/documentation/docsets/ApexCLI.docset/Contents/Resources/Documents/cheatset_resources/Open_Sans_Bold.woff +0 -0
- data/ext/apex_ext/apex_src/documentation/docsets/ApexCLI.docset/Contents/Resources/Documents/cheatset_resources/Open_Sans_Bold_Italic.woff +0 -0
- data/ext/apex_ext/apex_src/documentation/docsets/ApexCLI.docset/Contents/Resources/Documents/cheatset_resources/Open_Sans_Extrabold.woff +0 -0
- data/ext/apex_ext/apex_src/documentation/docsets/ApexCLI.docset/Contents/Resources/Documents/cheatset_resources/Open_Sans_Extrabold_Italic.woff +0 -0
- data/ext/apex_ext/apex_src/documentation/docsets/ApexCLI.docset/Contents/Resources/Documents/cheatset_resources/Open_Sans_Italic.woff +0 -0
- data/ext/apex_ext/apex_src/documentation/docsets/ApexCLI.docset/Contents/Resources/Documents/cheatset_resources/Open_Sans_Semibold.woff +0 -0
- data/ext/apex_ext/apex_src/documentation/docsets/ApexCLI.docset/Contents/Resources/Documents/cheatset_resources/Open_Sans_Semibold_Italic.woff +0 -0
- data/ext/apex_ext/apex_src/documentation/docsets/ApexCLI.docset/Contents/Resources/Documents/index.html +914 -0
- data/ext/apex_ext/apex_src/documentation/docsets/ApexCLI.docset/Contents/Resources/Documents/style.css +399 -0
- data/ext/apex_ext/apex_src/documentation/docsets/ApexCLI.docset/Contents/Resources/docSet.dsidx +0 -0
- data/ext/apex_ext/apex_src/documentation/docsets/ApexCLI.docset/Contents/Resources/optimizedIndex.dsidx +0 -0
- data/ext/apex_ext/apex_src/documentation/generate_app_docs.rb +772 -0
- data/ext/apex_ext/apex_src/documentation/generate_app_docs_ai.rb +678 -0
- data/ext/apex_ext/apex_src/documentation/generate_docset.rb +873 -0
- data/ext/apex_ext/apex_src/documentation/generate_single_html.rb +733 -0
- data/ext/apex_ext/apex_src/documentation/html/apex-docs.html +17073 -0
- data/ext/apex_ext/apex_src/documentation/shared_scripts.js +64 -0
- data/ext/apex_ext/apex_src/documentation/shared_styles.css +646 -0
- data/ext/apex_ext/apex_src/documentation/transform_for_app.example.md +260 -0
- data/ext/apex_ext/apex_src/examples/bracketed_spans_demo.md +119 -0
- data/ext/apex_ext/apex_src/examples/emoji_span_plugin.yml +11 -0
- data/ext/apex_ext/apex_src/examples/example.html +53 -0
- data/ext/apex_ext/apex_src/examples/example.md +85 -0
- data/ext/apex_ext/apex_src/examples/fenced_divs_demo.md +158 -0
- data/ext/apex_ext/apex_src/examples/kbd.md +8 -0
- data/ext/apex_ext/apex_src/examples/kbd_plugin.rb +250 -0
- data/ext/apex_ext/apex_src/examples/kbd_plugin.yml +9 -0
- data/ext/apex_ext/apex_src/icon/apexicon-outline-black.png +0 -0
- data/ext/apex_ext/apex_src/icon/apexicon-outline-black@2x.png +0 -0
- data/ext/apex_ext/apex_src/icon/apexicon-outline-mark.png +0 -0
- data/ext/apex_ext/apex_src/icon/apexicon-outline-mark@2x.png +0 -0
- data/ext/apex_ext/apex_src/icon/apexicon-outline-white.png +0 -0
- data/ext/apex_ext/apex_src/icon/apexicon-outline-white@2x.png +0 -0
- data/ext/apex_ext/apex_src/icon/apexicon.png +0 -0
- data/ext/apex_ext/apex_src/icon/apexicon@2x.png +0 -0
- data/ext/apex_ext/apex_src/include/apex/apex.h +247 -0
- data/ext/apex_ext/apex_src/include/apex/buffer.h +93 -0
- data/ext/apex_ext/apex_src/include/apex/module.modulemap +16 -0
- data/ext/apex_ext/apex_src/include/apex/parser.h +150 -0
- data/ext/apex_ext/apex_src/include/apex/renderer.h +39 -0
- data/ext/apex_ext/apex_src/man/apex-config.5 +374 -0
- data/ext/apex_ext/apex_src/man/apex-config.5.md +260 -0
- data/ext/apex_ext/apex_src/man/apex-plugins.7 +456 -0
- data/ext/apex_ext/apex_src/man/apex-plugins.7.md +365 -0
- data/ext/apex_ext/apex_src/man/apex.1 +828 -0
- data/ext/apex_ext/apex_src/man/apex.1.md +643 -0
- data/ext/apex_ext/apex_src/man/apex.1.new +338 -0
- data/ext/apex_ext/apex_src/objc/Apex.swift +237 -0
- data/ext/apex_ext/apex_src/objc/NSString+Apex.h +117 -0
- data/ext/apex_ext/apex_src/objc/NSString+Apex.m +332 -0
- data/ext/apex_ext/apex_src/src/_README.md +358 -0
- data/ext/apex_ext/apex_src/src/apex.c +6326 -0
- data/ext/apex_ext/apex_src/src/buffer.c +93 -0
- data/ext/apex_ext/apex_src/src/extensions/abbreviations.c +362 -0
- data/ext/apex_ext/apex_src/src/extensions/abbreviations.h +45 -0
- data/ext/apex_ext/apex_src/src/extensions/advanced_footnotes.c +184 -0
- data/ext/apex_ext/apex_src/src/extensions/advanced_footnotes.h +50 -0
- data/ext/apex_ext/apex_src/src/extensions/advanced_tables.c +1897 -0
- data/ext/apex_ext/apex_src/src/extensions/advanced_tables.h +42 -0
- data/ext/apex_ext/apex_src/src/extensions/callouts.c +215 -0
- data/ext/apex_ext/apex_src/src/extensions/callouts.h +53 -0
- data/ext/apex_ext/apex_src/src/extensions/citations.c +2042 -0
- data/ext/apex_ext/apex_src/src/extensions/citations.h +163 -0
- data/ext/apex_ext/apex_src/src/extensions/critic.c +329 -0
- data/ext/apex_ext/apex_src/src/extensions/critic.h +48 -0
- data/ext/apex_ext/apex_src/src/extensions/definition_list.c +1670 -0
- data/ext/apex_ext/apex_src/src/extensions/definition_list.h +42 -0
- data/ext/apex_ext/apex_src/src/extensions/emoji.c +710 -0
- data/ext/apex_ext/apex_src/src/extensions/emoji.h +38 -0
- data/ext/apex_ext/apex_src/src/extensions/emoji_data.h +942 -0
- data/ext/apex_ext/apex_src/src/extensions/fenced_divs.c +925 -0
- data/ext/apex_ext/apex_src/src/extensions/fenced_divs.h +43 -0
- data/ext/apex_ext/apex_src/src/extensions/github-emoji.txt +869 -0
- data/ext/apex_ext/apex_src/src/extensions/grid_tables.c +1121 -0
- data/ext/apex_ext/apex_src/src/extensions/grid_tables.h +33 -0
- data/ext/apex_ext/apex_src/src/extensions/header_ids.c +626 -0
- data/ext/apex_ext/apex_src/src/extensions/header_ids.h +60 -0
- data/ext/apex_ext/apex_src/src/extensions/highlight.c +135 -0
- data/ext/apex_ext/apex_src/src/extensions/highlight.h +16 -0
- data/ext/apex_ext/apex_src/src/extensions/html_markdown.c +408 -0
- data/ext/apex_ext/apex_src/src/extensions/html_markdown.h +42 -0
- data/ext/apex_ext/apex_src/src/extensions/ial.c +4084 -0
- data/ext/apex_ext/apex_src/src/extensions/ial.h +145 -0
- data/ext/apex_ext/apex_src/src/extensions/includes.c +1536 -0
- data/ext/apex_ext/apex_src/src/extensions/includes.h +54 -0
- data/ext/apex_ext/apex_src/src/extensions/index.c +967 -0
- data/ext/apex_ext/apex_src/src/extensions/index.h +90 -0
- data/ext/apex_ext/apex_src/src/extensions/inline_footnotes.c +205 -0
- data/ext/apex_ext/apex_src/src/extensions/inline_footnotes.h +34 -0
- data/ext/apex_ext/apex_src/src/extensions/inline_tables.c +332 -0
- data/ext/apex_ext/apex_src/src/extensions/inline_tables.h +13 -0
- data/ext/apex_ext/apex_src/src/extensions/insert.c +248 -0
- data/ext/apex_ext/apex_src/src/extensions/insert.h +18 -0
- data/ext/apex_ext/apex_src/src/extensions/math.c +279 -0
- data/ext/apex_ext/apex_src/src/extensions/math.h +32 -0
- data/ext/apex_ext/apex_src/src/extensions/metadata.c +3046 -0
- data/ext/apex_ext/apex_src/src/extensions/metadata.h +125 -0
- data/ext/apex_ext/apex_src/src/extensions/relaxed_tables.c +1297 -0
- data/ext/apex_ext/apex_src/src/extensions/relaxed_tables.h +39 -0
- data/ext/apex_ext/apex_src/src/extensions/special_markers.c +194 -0
- data/ext/apex_ext/apex_src/src/extensions/special_markers.h +29 -0
- data/ext/apex_ext/apex_src/src/extensions/sup_sub.c +405 -0
- data/ext/apex_ext/apex_src/src/extensions/sup_sub.h +16 -0
- data/ext/apex_ext/apex_src/src/extensions/syntax_highlight.c +468 -0
- data/ext/apex_ext/apex_src/src/extensions/syntax_highlight.h +44 -0
- data/ext/apex_ext/apex_src/src/extensions/table_html_postprocess.c +2679 -0
- data/ext/apex_ext/apex_src/src/extensions/table_html_postprocess.h +23 -0
- data/ext/apex_ext/apex_src/src/extensions/toc.c +255 -0
- data/ext/apex_ext/apex_src/src/extensions/toc.h +34 -0
- data/ext/apex_ext/apex_src/src/extensions/wiki_links.c +624 -0
- data/ext/apex_ext/apex_src/src/extensions/wiki_links.h +58 -0
- data/ext/apex_ext/apex_src/src/html_renderer.c +2762 -0
- data/ext/apex_ext/apex_src/src/html_renderer.h +126 -0
- data/ext/apex_ext/apex_src/src/parser.c +227 -0
- data/ext/apex_ext/apex_src/src/plugins.c +895 -0
- data/ext/apex_ext/apex_src/src/plugins.h +39 -0
- data/ext/apex_ext/apex_src/src/plugins_env.c +187 -0
- data/ext/apex_ext/apex_src/src/plugins_remote.c +263 -0
- data/ext/apex_ext/apex_src/src/pretty_html.c +358 -0
- data/ext/apex_ext/apex_src/src/renderer.c +241 -0
- data/ext/apex_ext/apex_src/src/utf8.c +56 -0
- data/ext/apex_ext/apex_src/test-linux-build.sh +20 -0
- data/ext/apex_ext/apex_src/test.html +103 -0
- data/ext/apex_ext/apex_src/test_coverage.sh +121 -0
- data/ext/apex_ext/apex_src/test_ial_fenced.md +6 -0
- data/ext/apex_ext/apex_src/test_math_norm.py +79 -0
- data/ext/apex_ext/apex_src/test_pandoc_output.html +48 -0
- data/ext/apex_ext/apex_src/test_spm.sh +107 -0
- data/ext/apex_ext/apex_src/tests/ApexSPMTest/main.swift +50 -0
- data/ext/apex_ext/apex_src/tests/BENCHMARK_RESULTS.md +229 -0
- data/ext/apex_ext/apex_src/tests/CMakeLists.txt +24 -0
- data/ext/apex_ext/apex_src/tests/README.md +146 -0
- data/ext/apex_ext/apex_src/tests/benchmark.sh +113 -0
- data/ext/apex_ext/apex_src/tests/benchmark_comparison.sh +166 -0
- data/ext/apex_ext/apex_src/tests/compare_header_ids.sh +31 -0
- data/ext/apex_ext/apex_src/tests/fixtures/basic/headers.md +25 -0
- data/ext/apex_ext/apex_src/tests/fixtures/basic/list-interruption.md +24 -0
- data/ext/apex_ext/apex_src/tests/fixtures/basic/misc_markup.md +33 -0
- data/ext/apex_ext/apex_src/tests/fixtures/basic/test_basic.md +26 -0
- data/ext/apex_ext/apex_src/tests/fixtures/code/code-blocks.md +260 -0
- data/ext/apex_ext/apex_src/tests/fixtures/combine_summary/SUMMARY.md +6 -0
- data/ext/apex_ext/apex_src/tests/fixtures/combine_summary/chapter1.md +7 -0
- data/ext/apex_ext/apex_src/tests/fixtures/combine_summary/index.txt +9 -0
- data/ext/apex_ext/apex_src/tests/fixtures/combine_summary/intro.md +5 -0
- data/ext/apex_ext/apex_src/tests/fixtures/combine_summary/section1_1.md +5 -0
- data/ext/apex_ext/apex_src/tests/fixtures/comprehensive_test.md +620 -0
- data/ext/apex_ext/apex_src/tests/fixtures/debug_ref_image_ial.md +3 -0
- data/ext/apex_ext/apex_src/tests/fixtures/demos/ial.md +11 -0
- data/ext/apex_ext/apex_src/tests/fixtures/demos/ial_demo.md +177 -0
- data/ext/apex_ext/apex_src/tests/fixtures/extensions/emoji-autocorrect.md +94 -0
- data/ext/apex_ext/apex_src/tests/fixtures/extensions/emoji_test.md +3 -0
- data/ext/apex_ext/apex_src/tests/fixtures/extensions/kbd_test.md +3 -0
- data/ext/apex_ext/apex_src/tests/fixtures/ial/bracketed_spans_test.md +74 -0
- data/ext/apex_ext/apex_src/tests/fixtures/images/image_and_encoding_test.md +27 -0
- data/ext/apex_ext/apex_src/tests/fixtures/images/multimarkdown_image_attributes_test.md +60 -0
- data/ext/apex_ext/apex_src/tests/fixtures/images/pandoc_ial_image_test.md +27 -0
- data/ext/apex_ext/apex_src/tests/fixtures/images/width_height_conversion_test.md +94 -0
- data/ext/apex_ext/apex_src/tests/fixtures/img-in-div.md +16 -0
- data/ext/apex_ext/apex_src/tests/fixtures/includes/code.py +4 -0
- data/ext/apex_ext/apex_src/tests/fixtures/includes/data.csv +5 -0
- data/ext/apex_ext/apex_src/tests/fixtures/includes/data.tsv +5 -0
- data/ext/apex_ext/apex_src/tests/fixtures/includes/image.png +2 -0
- data/ext/apex_ext/apex_src/tests/fixtures/includes/metadata_options.yml +11 -0
- data/ext/apex_ext/apex_src/tests/fixtures/includes/nested.md +8 -0
- data/ext/apex_ext/apex_src/tests/fixtures/includes/raw.html +4 -0
- data/ext/apex_ext/apex_src/tests/fixtures/includes/simple.md +7 -0
- data/ext/apex_ext/apex_src/tests/fixtures/includes/test_image.png +0 -0
- data/ext/apex_ext/apex_src/tests/fixtures/large_doc.md +1094 -0
- data/ext/apex_ext/apex_src/tests/fixtures/metadata_options.yml +11 -0
- data/ext/apex_ext/apex_src/tests/fixtures/output/gfm_header_id_test.md +96 -0
- data/ext/apex_ext/apex_src/tests/fixtures/output/test_citations.md +43 -0
- data/ext/apex_ext/apex_src/tests/fixtures/output/test_def_list_links.md +12 -0
- data/ext/apex_ext/apex_src/tests/fixtures/output/test_index_mmark.md +53 -0
- data/ext/apex_ext/apex_src/tests/fixtures/output/test_index_textindex.md +37 -0
- data/ext/apex_ext/apex_src/tests/fixtures/tables/advanced_tables_test.md +93 -0
- data/ext/apex_ext/apex_src/tests/fixtures/tables/inline_tables_test.md +38 -0
- data/ext/apex_ext/apex_src/tests/fixtures/tables/relaxed-table.md +12 -0
- data/ext/apex_ext/apex_src/tests/fixtures/tables/table_cr_line_endings.md +15 -0
- data/ext/apex_ext/apex_src/tests/fixtures/tables/table_no_trailing_newline.md +15 -0
- data/ext/apex_ext/apex_src/tests/generate_gfm_ids.sh +105 -0
- data/ext/apex_ext/apex_src/tests/generate_ial_demo.sh +143 -0
- data/ext/apex_ext/apex_src/tests/gfm_id_comparison_summary.md +96 -0
- data/ext/apex_ext/apex_src/tests/gh_api_test.md +6 -0
- data/ext/apex_ext/apex_src/tests/ial_demo.html +186 -0
- data/ext/apex_ext/apex_src/tests/include_code.py +19 -0
- data/ext/apex_ext/apex_src/tests/include_snippet.md +15 -0
- data/ext/apex_ext/apex_src/tests/multi_file_cli_test.sh +64 -0
- data/ext/apex_ext/apex_src/tests/sample_data.csv +7 -0
- data/ext/apex_ext/apex_src/tests/table_escaped_ltlt.md +4 -0
- data/ext/apex_ext/apex_src/tests/test_basic.c +74 -0
- data/ext/apex_ext/apex_src/tests/test_extensions.c +2116 -0
- data/ext/apex_ext/apex_src/tests/test_helpers.c +183 -0
- data/ext/apex_ext/apex_src/tests/test_helpers.h +91 -0
- data/ext/apex_ext/apex_src/tests/test_ial.c +282 -0
- data/ext/apex_ext/apex_src/tests/test_links.c +418 -0
- data/ext/apex_ext/apex_src/tests/test_marked_integration.c +265 -0
- data/ext/apex_ext/apex_src/tests/test_metadata.c +908 -0
- data/ext/apex_ext/apex_src/tests/test_output.c +1118 -0
- data/ext/apex_ext/apex_src/tests/test_plugins.c +219 -0
- data/ext/apex_ext/apex_src/tests/test_refs.bib +31 -0
- data/ext/apex_ext/apex_src/tests/test_runner.c +244 -0
- data/ext/apex_ext/apex_src/tests/test_syntax_highlight.c +198 -0
- data/ext/apex_ext/apex_src/tests/test_tables.c +862 -0
- data/ext/apex_ext/apex_src/tests/update_benchmarks.sh +9 -0
- data/ext/apex_ext/apex_src/tests/yaml_test.md +13 -0
- data/ext/apex_ext/apex_src/tests.rb +39 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/CMakeLists.txt +48 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/COPYING +170 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/CheckFileOffsetBits.c +14 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/CheckFileOffsetBits.cmake +43 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/FindAsan.cmake +74 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/Makefile.nmake +38 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/README.md +206 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/api_test/CMakeLists.txt +30 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/api_test/cplusplus.cpp +15 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/api_test/cplusplus.h +16 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/api_test/harness.c +111 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/api_test/harness.h +35 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/api_test/main.c +1169 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/appveyor.yml +21 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/bench/samples/block-bq-flat.md +16 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/bench/samples/block-bq-nested.md +13 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/bench/samples/block-code.md +11 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/bench/samples/block-fences.md +14 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/bench/samples/block-heading.md +9 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/bench/samples/block-hr.md +10 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/bench/samples/block-html.md +32 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/bench/samples/block-lheading.md +8 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/bench/samples/block-list-flat.md +67 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/bench/samples/block-list-nested.md +36 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/bench/samples/block-ref-flat.md +15 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/bench/samples/block-ref-nested.md +17 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/bench/samples/inline-autolink.md +14 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/bench/samples/inline-backticks.md +3 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/bench/samples/inline-em-flat.md +5 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/bench/samples/inline-em-nested.md +5 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/bench/samples/inline-em-worst.md +5 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/bench/samples/inline-entity.md +11 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/bench/samples/inline-escape.md +15 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/bench/samples/inline-html.md +44 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/bench/samples/inline-links-flat.md +23 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/bench/samples/inline-links-nested.md +13 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/bench/samples/inline-newlines.md +24 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/bench/samples/lorem1.md +13 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/bench/samples/rawtabs.md +18 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/bench/statistics.py +595 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/bench/stats.py +19 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/benchmarks.md +33 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/changelog.txt +1245 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/data/CaseFolding.txt +1495 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/extensions/CMakeLists.txt +119 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/extensions/autolink.c +508 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/extensions/autolink.h +8 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/extensions/cmark-gfm-core-extensions.h +54 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/extensions/core-extensions.c +27 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/extensions/ext_scanners.c +879 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/extensions/ext_scanners.h +24 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/extensions/ext_scanners.re +92 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/extensions/strikethrough.c +167 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/extensions/strikethrough.h +9 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/extensions/table.c +917 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/extensions/table.h +12 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/extensions/tagfilter.c +60 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/extensions/tagfilter.h +8 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/extensions/tasklist.c +156 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/extensions/tasklist.h +8 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/fuzz/CMakeLists.txt +22 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/fuzz/README.md +12 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/fuzz/fuzz_quadratic.c +91 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/fuzz/fuzz_quadratic_brackets.c +110 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/fuzz/fuzzloop.sh +28 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/man/CMakeLists.txt +10 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/man/make_man_page.py +133 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/man/man1/cmark-gfm.1 +78 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/man/man3/cmark-gfm.3 +1041 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/nmake.bat +1 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/CMakeLists.txt +230 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/arena.c +104 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/blocks.c +1622 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/buffer.c +278 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/buffer.h +116 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/case_fold_switch.inc +4327 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/chunk.h +135 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/cmark-gfm-extension_api.h +737 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/cmark-gfm.h +833 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/cmark-gfm_version.h.in +7 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/cmark.c +55 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/cmark_ctype.c +44 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/cmark_ctype.h +33 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/commonmark.c +514 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/config.h.in +76 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/entities.inc +2138 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/footnotes.c +63 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/footnotes.h +27 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/houdini.h +57 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/houdini_href_e.c +100 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/houdini_html_e.c +66 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/houdini_html_u.c +149 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/html.c +502 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/html.h +27 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/inlines.c +1788 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/inlines.h +29 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/iterator.c +159 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/iterator.h +26 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/latex.c +468 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/libcmark-gfm.pc.in +10 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/linked_list.c +37 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/main.c +328 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/man.c +274 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/map.c +129 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/map.h +44 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/node.c +1045 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/node.h +167 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/parser.h +59 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/plaintext.c +218 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/plugin.c +36 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/plugin.h +34 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/references.c +43 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/references.h +26 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/registry.c +63 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/registry.h +24 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/render.c +213 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/render.h +62 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/scanners.c +14056 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/scanners.h +70 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/scanners.re +365 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/syntax_extension.c +149 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/syntax_extension.h +34 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/utf8.c +317 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/utf8.h +35 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/xml.c +182 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/suppressions +10 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/test/CMakeLists.txt +114 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/test/afl_test_cases/test.md +49 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/test/cmark-fuzz.c +58 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/test/cmark.py +105 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/test/entity_tests.py +67 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/test/extensions-full-info-string.txt +0 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/test/extensions-table-prefer-style-attributes.txt +38 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/test/extensions.txt +920 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/test/fuzzing_dictionary +67 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/test/normalize.py +194 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/test/pathological_tests.py +160 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/test/regression.txt +375 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/test/roundtrip_tests.py +50 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/test/run-cmark-fuzz +4 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/test/smart_punct.txt +177 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/test/spec.txt +10212 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/test/spec_tests.py +152 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/toolchain-mingw32.cmake +17 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/tools/Dockerfile +41 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/tools/appveyor-build.bat +13 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/tools/make_entities_inc.py +32 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/tools/mkcasefold.pl +22 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/tools/xml2md.xsl +319 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/tools/xml2md_gfm.xsl +80 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/why-cmark-and-not-x.md +104 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/wrappers/wrapper.js +6 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/wrappers/wrapper.py +37 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/wrappers/wrapper.rb +15 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/wrappers/wrapper.rkt +208 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/wrappers/wrapper_ext.py +109 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/CMakeLists.txt +160 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/Changes +372 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/License +20 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/Makefile.am +51 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/ReadMe.md +46 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/announcement.msg +89 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/bootstrap +3 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/cmake/config.h.in +4 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/configure.ac +73 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/doc/doxygen.cfg +222 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/docker/README.mkd +17 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/docker/alpine-3.7 +26 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/docker/fedora-25 +26 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/docker/ubuntu-14.04 +29 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/docker/ubuntu-16.04 +24 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/examples/anchors.yaml +10 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/examples/array.yaml +2 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/examples/global-tag.yaml +14 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/examples/json.yaml +1 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/examples/mapping.yaml +2 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/examples/numbers.yaml +1 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/examples/strings.yaml +7 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/examples/tags.yaml +7 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/examples/yaml-version.yaml +3 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/include/Makefile.am +17 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/include/yaml.h +1999 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/pkg/ReadMe.md +77 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/pkg/docker/Dockerfile +32 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/pkg/docker/output/ReadMe +1 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/pkg/docker/scripts/libyaml-dist.sh +23 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/regression-inputs/clusterfuzz-testcase-minimized-5607885063061504.yml +1 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/src/Makefile.am +4 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/src/api.c +1393 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/src/dumper.c +394 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/src/emitter.c +2358 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/src/loader.c +544 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/src/parser.c +1416 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/src/reader.c +469 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/src/scanner.c +3598 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/src/writer.c +141 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/src/yaml_private.h +684 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/tests/CMakeLists.txt +27 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/tests/Makefile.am +9 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/tests/ReadMe.md +63 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/tests/example-deconstructor-alt.c +800 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/tests/example-deconstructor.c +1127 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/tests/example-reformatter-alt.c +217 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/tests/example-reformatter.c +202 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/tests/run-all-tests.sh +29 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/tests/run-dumper.c +314 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/tests/run-emitter-test-suite.c +290 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/tests/run-emitter.c +327 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/tests/run-loader.c +63 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/tests/run-parser-test-suite.c +196 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/tests/run-parser.c +88 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/tests/run-scanner.c +63 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/tests/test-reader.c +354 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/tests/test-version.c +29 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/yaml-0.1.pc.in +10 -0
- data/ext/apex_ext/apex_src/vendor/libyaml/yamlConfig.cmake.in +16 -0
- data/ext/apex_ext/extconf.rb +103 -0
- data/lib/apex/configurable.rb +46 -0
- data/lib/apex/document.rb +66 -0
- data/lib/apex/version.rb +15 -0
- data/lib/apex.rb +28 -0
- metadata +544 -0
|
@@ -0,0 +1,1420 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
|
|
4
|
+
<head>
|
|
5
|
+
|
|
6
|
+
<meta charset="UTF-8">
|
|
7
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
8
|
+
<meta name="generator" content="Apex 0.1.49">
|
|
9
|
+
<title>Document</title>
|
|
10
|
+
<style>
|
|
11
|
+
body {
|
|
12
|
+
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Helvetica, Arial, sans-serif;
|
|
13
|
+
line-height: 1.6;
|
|
14
|
+
max-width: 800px;
|
|
15
|
+
margin: 2rem auto;
|
|
16
|
+
padding: 0 1rem;
|
|
17
|
+
color: #333;
|
|
18
|
+
}
|
|
19
|
+
pre { background: #f5f5f5; padding: 1rem; overflow-x: auto; }
|
|
20
|
+
code { background: #f0f0f0; padding: 0.2em 0.4em; border-radius: 3px; }
|
|
21
|
+
blockquote { border-left: 4px solid #ddd; margin: 0; padding-left: 1rem; color: #666; }
|
|
22
|
+
table { border-collapse: collapse; width: 100%%; }
|
|
23
|
+
th, td { border: 1px solid #ddd; padding: 0.5rem; }
|
|
24
|
+
th { background: #f5f5f5; }
|
|
25
|
+
tfoot td { background: #e8e8e8; }
|
|
26
|
+
figure.table-figure { width: fit-content; margin: 1em 0; }
|
|
27
|
+
figure.table-figure table { width: auto; }
|
|
28
|
+
figcaption { text-align: center; font-weight: bold; font-size: 0.8em; }
|
|
29
|
+
.page-break { page-break-after: always; }
|
|
30
|
+
.callout { padding: 1rem; margin: 1rem 0; border-left: 4px solid; }
|
|
31
|
+
.callout-note { border-color: #3b82f6; background: #eff6ff; }
|
|
32
|
+
.callout-warning { border-color: #f59e0b; background: #fffbeb; }
|
|
33
|
+
.callout-tip { border-color: #10b981; background: #f0fdf4; }
|
|
34
|
+
.callout-danger { border-color: #ef4444; background: #fef2f2; }
|
|
35
|
+
ins { background: #d4fcbc; text-decoration: none; }
|
|
36
|
+
del { background: #fbb6c2; text-decoration: line-through; }
|
|
37
|
+
mark { background: #fff3cd; }
|
|
38
|
+
.critic.comment { background: #e7e7e7; color: #666; font-style: italic; }
|
|
39
|
+
</style>
|
|
40
|
+
<style>
|
|
41
|
+
/* Base styles */
|
|
42
|
+
body {
|
|
43
|
+
-webkit-font-smoothing: antialiased;
|
|
44
|
+
-moz-osx-font-smoothing: grayscale;
|
|
45
|
+
font-size: 17px;
|
|
46
|
+
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto,
|
|
47
|
+
"Helvetica Neue", Arial, sans-serif;
|
|
48
|
+
line-height: 1.65;
|
|
49
|
+
color: #1e293b;
|
|
50
|
+
background-color: #fff;
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
/* Sidebar / Main TOC - wider on larger screens */
|
|
54
|
+
.main-toc,
|
|
55
|
+
.sidebar {
|
|
56
|
+
position: fixed;
|
|
57
|
+
left: 0;
|
|
58
|
+
top: 0;
|
|
59
|
+
width: auto;
|
|
60
|
+
min-width: 180px;
|
|
61
|
+
max-width: 250px;
|
|
62
|
+
height: 100vh;
|
|
63
|
+
overflow-y: auto;
|
|
64
|
+
background: #1e293b;
|
|
65
|
+
color: rgba(255, 255, 255, 0.9);
|
|
66
|
+
border-right: 2px solid rgba(255, 255, 255, 0.1);
|
|
67
|
+
padding: 24px 20px 130px;
|
|
68
|
+
font-size: 14px;
|
|
69
|
+
z-index: 100;
|
|
70
|
+
margin-right: 1rem;
|
|
71
|
+
box-shadow: 4px 0 24px rgba(0, 0, 0, 0.08);
|
|
72
|
+
transition: transform 0.3s ease;
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
.main-toc ul,
|
|
76
|
+
.sidebar ul {
|
|
77
|
+
list-style: none;
|
|
78
|
+
padding-left: 0;
|
|
79
|
+
margin: 0;
|
|
80
|
+
padding-bottom: 80px;
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
.main-toc ul::after,
|
|
84
|
+
.sidebar ul::after {
|
|
85
|
+
content: "";
|
|
86
|
+
display: block;
|
|
87
|
+
height: 80px;
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
.main-toc li,
|
|
91
|
+
.sidebar li {
|
|
92
|
+
margin: 0.25em 0;
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
.main-toc a,
|
|
96
|
+
.sidebar a {
|
|
97
|
+
color: rgba(255, 255, 255, 0.85);
|
|
98
|
+
text-decoration: none;
|
|
99
|
+
display: block;
|
|
100
|
+
padding: 6px 12px;
|
|
101
|
+
border-radius: 4px;
|
|
102
|
+
transition: all 0.15s ease;
|
|
103
|
+
white-space: nowrap;
|
|
104
|
+
overflow: hidden;
|
|
105
|
+
text-overflow: ellipsis;
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
.main-toc a:hover,
|
|
109
|
+
.sidebar a:hover {
|
|
110
|
+
background: #334155;
|
|
111
|
+
color: #fff;
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
.sidebar a.active {
|
|
115
|
+
color: #0ea5e9;
|
|
116
|
+
font-weight: 500;
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
/* Body margin for sidebar */
|
|
120
|
+
body {
|
|
121
|
+
margin-left: 270px;
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
/* Hamburger menu button */
|
|
125
|
+
.hamburger-menu {
|
|
126
|
+
display: none;
|
|
127
|
+
position: fixed;
|
|
128
|
+
top: 12px;
|
|
129
|
+
left: 12px;
|
|
130
|
+
z-index: 200;
|
|
131
|
+
background: #1e293b;
|
|
132
|
+
border: 2px solid rgba(255, 255, 255, 0.1);
|
|
133
|
+
border-radius: 6px;
|
|
134
|
+
padding: 10px;
|
|
135
|
+
cursor: pointer;
|
|
136
|
+
color: rgba(255, 255, 255, 0.9);
|
|
137
|
+
font-size: 20px;
|
|
138
|
+
line-height: 1;
|
|
139
|
+
width: 44px;
|
|
140
|
+
height: 44px;
|
|
141
|
+
align-items: center;
|
|
142
|
+
justify-content: center;
|
|
143
|
+
box-shadow: 0 2px 8px rgba(0, 0, 0, 0.2);
|
|
144
|
+
transition: all 0.2s ease;
|
|
145
|
+
opacity: 0.2;
|
|
146
|
+
}
|
|
147
|
+
|
|
148
|
+
.hamburger-menu:hover {
|
|
149
|
+
background: #334155;
|
|
150
|
+
color: #fff;
|
|
151
|
+
opacity: 1;
|
|
152
|
+
}
|
|
153
|
+
|
|
154
|
+
/* Move hamburger to the right of the sidebar when menu is open */
|
|
155
|
+
.hamburger-menu.active {
|
|
156
|
+
left: calc(
|
|
157
|
+
250px + 12px
|
|
158
|
+
); /* Position just to the right of sidebar (max-width 250px + 12px padding) */
|
|
159
|
+
}
|
|
160
|
+
|
|
161
|
+
.hamburger-menu.active {
|
|
162
|
+
background: #0ea5e9;
|
|
163
|
+
}
|
|
164
|
+
|
|
165
|
+
.hamburger-menu::before {
|
|
166
|
+
content: "☰";
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
.hamburger-menu.active::before {
|
|
170
|
+
content: "✕";
|
|
171
|
+
}
|
|
172
|
+
|
|
173
|
+
/* Mobile menu overlay */
|
|
174
|
+
.mobile-menu-overlay {
|
|
175
|
+
display: none;
|
|
176
|
+
position: fixed;
|
|
177
|
+
top: 0;
|
|
178
|
+
left: 0;
|
|
179
|
+
right: 0;
|
|
180
|
+
bottom: 0;
|
|
181
|
+
background: rgba(0, 0, 0, 0.5);
|
|
182
|
+
z-index: 150;
|
|
183
|
+
opacity: 0;
|
|
184
|
+
visibility: hidden;
|
|
185
|
+
transition: opacity 0.3s ease, visibility 0.3s ease;
|
|
186
|
+
}
|
|
187
|
+
|
|
188
|
+
.mobile-menu-overlay.active {
|
|
189
|
+
opacity: 1;
|
|
190
|
+
visibility: visible;
|
|
191
|
+
}
|
|
192
|
+
|
|
193
|
+
/* Page TOC */
|
|
194
|
+
.page-toc {
|
|
195
|
+
background: #f9f9f9;
|
|
196
|
+
border: 1px solid #ddd;
|
|
197
|
+
border-radius: 4px;
|
|
198
|
+
padding: 1rem;
|
|
199
|
+
margin: 1.5rem 0;
|
|
200
|
+
}
|
|
201
|
+
|
|
202
|
+
.page-toc ul {
|
|
203
|
+
list-style: none;
|
|
204
|
+
padding-left: 0;
|
|
205
|
+
margin: 0;
|
|
206
|
+
}
|
|
207
|
+
|
|
208
|
+
.page-toc > ul {
|
|
209
|
+
padding-left: 0;
|
|
210
|
+
}
|
|
211
|
+
|
|
212
|
+
.page-toc li {
|
|
213
|
+
margin: 0.25em 0;
|
|
214
|
+
}
|
|
215
|
+
|
|
216
|
+
.page-toc a {
|
|
217
|
+
color: #0066cc;
|
|
218
|
+
text-decoration: none;
|
|
219
|
+
display: block;
|
|
220
|
+
padding: 0.25em 0.5em;
|
|
221
|
+
border-radius: 3px;
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
.page-toc a:hover {
|
|
225
|
+
background: #e0e0e0;
|
|
226
|
+
color: #004499;
|
|
227
|
+
}
|
|
228
|
+
|
|
229
|
+
.page-toc ul ul {
|
|
230
|
+
list-style: none;
|
|
231
|
+
padding-left: 1.5em;
|
|
232
|
+
margin-top: 0.25em;
|
|
233
|
+
margin-left: 0;
|
|
234
|
+
}
|
|
235
|
+
|
|
236
|
+
.page-toc ul ul ul {
|
|
237
|
+
padding-left: 1.5em;
|
|
238
|
+
}
|
|
239
|
+
|
|
240
|
+
.page-toc ul ul a {
|
|
241
|
+
font-size: 0.9em;
|
|
242
|
+
color: #555;
|
|
243
|
+
}
|
|
244
|
+
|
|
245
|
+
.page-toc ul ul ul a {
|
|
246
|
+
font-size: 0.85em;
|
|
247
|
+
color: #666;
|
|
248
|
+
}
|
|
249
|
+
|
|
250
|
+
/* Floating TOC */
|
|
251
|
+
.floating-toc {
|
|
252
|
+
position: fixed;
|
|
253
|
+
top: 0;
|
|
254
|
+
left: 270px;
|
|
255
|
+
right: 0;
|
|
256
|
+
z-index: 50;
|
|
257
|
+
opacity: 0;
|
|
258
|
+
visibility: hidden;
|
|
259
|
+
transition: opacity 0.2s ease, visibility 0.2s ease;
|
|
260
|
+
pointer-events: none;
|
|
261
|
+
display: flex;
|
|
262
|
+
justify-content: flex-end;
|
|
263
|
+
padding-right: 2rem;
|
|
264
|
+
}
|
|
265
|
+
|
|
266
|
+
.floating-toc.visible {
|
|
267
|
+
opacity: 1;
|
|
268
|
+
visibility: visible;
|
|
269
|
+
pointer-events: auto;
|
|
270
|
+
}
|
|
271
|
+
|
|
272
|
+
.floating-toc-container {
|
|
273
|
+
background: rgba(255, 255, 255, 0.95);
|
|
274
|
+
backdrop-filter: blur(10px);
|
|
275
|
+
border-bottom: 1px solid #ddd;
|
|
276
|
+
border-radius: 0 0 12px 12px;
|
|
277
|
+
box-shadow: 0 2px 8px rgba(0, 0, 0, 0.1);
|
|
278
|
+
width: fit-content;
|
|
279
|
+
max-width: 400px;
|
|
280
|
+
min-width: 200px;
|
|
281
|
+
overflow: hidden;
|
|
282
|
+
transition: max-height 0.3s ease;
|
|
283
|
+
}
|
|
284
|
+
|
|
285
|
+
.floating-toc-header {
|
|
286
|
+
padding: 8px 16px;
|
|
287
|
+
cursor: pointer;
|
|
288
|
+
user-select: none;
|
|
289
|
+
font-size: 14px;
|
|
290
|
+
font-weight: 500;
|
|
291
|
+
color: #1e293b;
|
|
292
|
+
display: flex;
|
|
293
|
+
align-items: center;
|
|
294
|
+
justify-content: space-between;
|
|
295
|
+
}
|
|
296
|
+
|
|
297
|
+
.floating-toc-header:hover {
|
|
298
|
+
background: rgba(0, 0, 0, 0.02);
|
|
299
|
+
}
|
|
300
|
+
|
|
301
|
+
.floating-toc-content {
|
|
302
|
+
max-height: 0;
|
|
303
|
+
overflow: hidden;
|
|
304
|
+
transition: max-height 0.3s ease;
|
|
305
|
+
}
|
|
306
|
+
|
|
307
|
+
.floating-toc-container:hover .floating-toc-content {
|
|
308
|
+
max-height: 70vh;
|
|
309
|
+
overflow-y: auto;
|
|
310
|
+
}
|
|
311
|
+
|
|
312
|
+
.floating-toc-content ul {
|
|
313
|
+
list-style: none;
|
|
314
|
+
padding: 8px 16px 16px;
|
|
315
|
+
margin: 0;
|
|
316
|
+
}
|
|
317
|
+
|
|
318
|
+
.floating-toc-content li {
|
|
319
|
+
margin: 0.1em 0;
|
|
320
|
+
}
|
|
321
|
+
|
|
322
|
+
.floating-toc-content a {
|
|
323
|
+
color: #0066cc;
|
|
324
|
+
text-decoration: none;
|
|
325
|
+
display: block;
|
|
326
|
+
padding: 0.2em 0.5em;
|
|
327
|
+
border-radius: 4px;
|
|
328
|
+
font-size: 13px;
|
|
329
|
+
transition: background 0.15s ease;
|
|
330
|
+
}
|
|
331
|
+
|
|
332
|
+
.floating-toc-content a:hover {
|
|
333
|
+
background: #e0e0e0;
|
|
334
|
+
color: #004499;
|
|
335
|
+
}
|
|
336
|
+
|
|
337
|
+
.floating-toc-content ul ul {
|
|
338
|
+
padding-left: 1.2em;
|
|
339
|
+
margin-top: 0;
|
|
340
|
+
margin-bottom: 0;
|
|
341
|
+
}
|
|
342
|
+
|
|
343
|
+
.floating-toc-content ul ul ul {
|
|
344
|
+
margin-top: 0;
|
|
345
|
+
margin-bottom: 0;
|
|
346
|
+
}
|
|
347
|
+
|
|
348
|
+
.floating-toc-content ul ul a {
|
|
349
|
+
font-size: 12px;
|
|
350
|
+
color: #555;
|
|
351
|
+
}
|
|
352
|
+
|
|
353
|
+
.floating-toc-content ul ul ul a {
|
|
354
|
+
font-size: 11px;
|
|
355
|
+
color: #666;
|
|
356
|
+
}
|
|
357
|
+
|
|
358
|
+
/* Smooth scrolling */
|
|
359
|
+
html {
|
|
360
|
+
scroll-behavior: smooth;
|
|
361
|
+
}
|
|
362
|
+
|
|
363
|
+
/* Code blocks */
|
|
364
|
+
code {
|
|
365
|
+
background: #f0f0f0;
|
|
366
|
+
padding: 0.2em 0.4em;
|
|
367
|
+
border-radius: 3px;
|
|
368
|
+
font-family: "Monaco", "Menlo", "Ubuntu Mono", monospace;
|
|
369
|
+
font-size: 0.9em;
|
|
370
|
+
margin: 0 0.1em;
|
|
371
|
+
}
|
|
372
|
+
|
|
373
|
+
pre {
|
|
374
|
+
background: #f5f5f5;
|
|
375
|
+
padding: 1rem;
|
|
376
|
+
overflow-x: auto;
|
|
377
|
+
border-radius: 4px;
|
|
378
|
+
margin: 1em 0;
|
|
379
|
+
}
|
|
380
|
+
|
|
381
|
+
pre code {
|
|
382
|
+
background: none;
|
|
383
|
+
padding: 0;
|
|
384
|
+
margin: 0;
|
|
385
|
+
}
|
|
386
|
+
|
|
387
|
+
/* Rouge syntax highlighting - GitHub theme, scoped to .highlight containers */
|
|
388
|
+
.highlight {
|
|
389
|
+
color: #24292e;
|
|
390
|
+
}
|
|
391
|
+
|
|
392
|
+
.highlight .c {
|
|
393
|
+
color: #6a737d;
|
|
394
|
+
font-style: italic;
|
|
395
|
+
} /* Comment */
|
|
396
|
+
.highlight .err {
|
|
397
|
+
color: #a61717;
|
|
398
|
+
background-color: #e3d2d2;
|
|
399
|
+
} /* Error */
|
|
400
|
+
.highlight .k {
|
|
401
|
+
color: #d73a49;
|
|
402
|
+
font-weight: bold;
|
|
403
|
+
} /* Keyword */
|
|
404
|
+
.highlight .l {
|
|
405
|
+
color: #032f62;
|
|
406
|
+
} /* Literal */
|
|
407
|
+
.highlight .n {
|
|
408
|
+
color: #24292e;
|
|
409
|
+
} /* Name */
|
|
410
|
+
.highlight .o {
|
|
411
|
+
color: #d73a49;
|
|
412
|
+
} /* Operator */
|
|
413
|
+
.highlight .p {
|
|
414
|
+
color: #24292e;
|
|
415
|
+
} /* Punctuation */
|
|
416
|
+
.highlight .cm {
|
|
417
|
+
color: #6a737d;
|
|
418
|
+
font-style: italic;
|
|
419
|
+
} /* Comment.Multiline */
|
|
420
|
+
.highlight .cp {
|
|
421
|
+
color: #6a737d;
|
|
422
|
+
font-weight: bold;
|
|
423
|
+
} /* Comment.Preproc */
|
|
424
|
+
.highlight .c1 {
|
|
425
|
+
color: #6a737d;
|
|
426
|
+
font-style: italic;
|
|
427
|
+
} /* Comment.Single */
|
|
428
|
+
.highlight .cs {
|
|
429
|
+
color: #6a737d;
|
|
430
|
+
font-weight: bold;
|
|
431
|
+
font-style: italic;
|
|
432
|
+
} /* Comment.Special */
|
|
433
|
+
.highlight .gd {
|
|
434
|
+
color: #24292e;
|
|
435
|
+
background-color: #ffeef0;
|
|
436
|
+
} /* Generic.Deleted */
|
|
437
|
+
.highlight .ge {
|
|
438
|
+
color: #24292e;
|
|
439
|
+
font-style: italic;
|
|
440
|
+
} /* Generic.Emph */
|
|
441
|
+
.highlight .gr {
|
|
442
|
+
color: #aa0000;
|
|
443
|
+
} /* Generic.Error */
|
|
444
|
+
.highlight .gh {
|
|
445
|
+
color: #999999;
|
|
446
|
+
font-weight: bold;
|
|
447
|
+
} /* Generic.Heading */
|
|
448
|
+
.highlight .gi {
|
|
449
|
+
color: #24292e;
|
|
450
|
+
background-color: #f0fff4;
|
|
451
|
+
} /* Generic.Inserted */
|
|
452
|
+
.highlight .go {
|
|
453
|
+
color: #888888;
|
|
454
|
+
} /* Generic.Output */
|
|
455
|
+
.highlight .gp {
|
|
456
|
+
color: #555555;
|
|
457
|
+
} /* Generic.Prompt */
|
|
458
|
+
.highlight .gs {
|
|
459
|
+
font-weight: bold;
|
|
460
|
+
} /* Generic.Strong */
|
|
461
|
+
.highlight .gu {
|
|
462
|
+
color: #aaaaaa;
|
|
463
|
+
} /* Generic.Subheading */
|
|
464
|
+
.highlight .gt {
|
|
465
|
+
color: #aa0000;
|
|
466
|
+
} /* Generic.Traceback */
|
|
467
|
+
.highlight .kc {
|
|
468
|
+
color: #d73a49;
|
|
469
|
+
font-weight: bold;
|
|
470
|
+
} /* Keyword.Constant */
|
|
471
|
+
.highlight .kd {
|
|
472
|
+
color: #d73a49;
|
|
473
|
+
font-weight: bold;
|
|
474
|
+
} /* Keyword.Declaration */
|
|
475
|
+
.highlight .kn {
|
|
476
|
+
color: #d73a49;
|
|
477
|
+
font-weight: bold;
|
|
478
|
+
} /* Keyword.Namespace */
|
|
479
|
+
.highlight .kp {
|
|
480
|
+
color: #d73a49;
|
|
481
|
+
font-weight: bold;
|
|
482
|
+
} /* Keyword.Pseudo */
|
|
483
|
+
.highlight .kr {
|
|
484
|
+
color: #d73a49;
|
|
485
|
+
font-weight: bold;
|
|
486
|
+
} /* Keyword.Reserved */
|
|
487
|
+
.highlight .kt {
|
|
488
|
+
color: #d73a49;
|
|
489
|
+
font-weight: bold;
|
|
490
|
+
} /* Keyword.Type */
|
|
491
|
+
.highlight .ld {
|
|
492
|
+
color: #032f62;
|
|
493
|
+
} /* Literal.Date */
|
|
494
|
+
.highlight .m {
|
|
495
|
+
color: #005cc5;
|
|
496
|
+
} /* Literal.Number */
|
|
497
|
+
.highlight .s {
|
|
498
|
+
color: #032f62;
|
|
499
|
+
} /* Literal.String */
|
|
500
|
+
.highlight .na {
|
|
501
|
+
color: #6f42c1;
|
|
502
|
+
} /* Name.Attribute */
|
|
503
|
+
.highlight .nb {
|
|
504
|
+
color: #005cc5;
|
|
505
|
+
} /* Name.Builtin */
|
|
506
|
+
.highlight .nc {
|
|
507
|
+
color: #6f42c1;
|
|
508
|
+
font-weight: bold;
|
|
509
|
+
} /* Name.Class */
|
|
510
|
+
.highlight .no {
|
|
511
|
+
color: #005cc5;
|
|
512
|
+
} /* Name.Constant */
|
|
513
|
+
.highlight .nd {
|
|
514
|
+
color: #6f42c1;
|
|
515
|
+
font-weight: bold;
|
|
516
|
+
} /* Name.Decorator */
|
|
517
|
+
.highlight .ni {
|
|
518
|
+
color: #800080;
|
|
519
|
+
} /* Name.Entity */
|
|
520
|
+
.highlight .ne {
|
|
521
|
+
color: #990000;
|
|
522
|
+
font-weight: bold;
|
|
523
|
+
} /* Name.Exception */
|
|
524
|
+
.highlight .nf {
|
|
525
|
+
color: #6f42c1;
|
|
526
|
+
} /* Name.Function */
|
|
527
|
+
.highlight .nl {
|
|
528
|
+
color: #990000;
|
|
529
|
+
} /* Name.Label */
|
|
530
|
+
.highlight .nn {
|
|
531
|
+
color: #555555;
|
|
532
|
+
} /* Name.Namespace */
|
|
533
|
+
.highlight .nx {
|
|
534
|
+
color: #6f42c1;
|
|
535
|
+
} /* Name.Other */
|
|
536
|
+
.highlight .py {
|
|
537
|
+
color: #990000;
|
|
538
|
+
} /* Name.Property */
|
|
539
|
+
.highlight .nt {
|
|
540
|
+
color: #22863a;
|
|
541
|
+
} /* Name.Tag */
|
|
542
|
+
.highlight .nv {
|
|
543
|
+
color: #e36209;
|
|
544
|
+
} /* Name.Variable */
|
|
545
|
+
.highlight .ow {
|
|
546
|
+
color: #d73a49;
|
|
547
|
+
font-weight: bold;
|
|
548
|
+
} /* Operator.Word */
|
|
549
|
+
.highlight .w {
|
|
550
|
+
color: #bbbbbb;
|
|
551
|
+
} /* Text.Whitespace */
|
|
552
|
+
.highlight .mf {
|
|
553
|
+
color: #005cc5;
|
|
554
|
+
} /* Literal.Number.Float */
|
|
555
|
+
.highlight .mh {
|
|
556
|
+
color: #005cc5;
|
|
557
|
+
} /* Literal.Number.Hex */
|
|
558
|
+
.highlight .mi {
|
|
559
|
+
color: #005cc5;
|
|
560
|
+
} /* Literal.Number.Integer */
|
|
561
|
+
.highlight .mo {
|
|
562
|
+
color: #005cc5;
|
|
563
|
+
} /* Literal.Number.Oct */
|
|
564
|
+
.highlight .sb {
|
|
565
|
+
color: #032f62;
|
|
566
|
+
} /* Literal.String.Backtick */
|
|
567
|
+
.highlight .sc {
|
|
568
|
+
color: #032f62;
|
|
569
|
+
} /* Literal.String.Char */
|
|
570
|
+
.highlight .sd {
|
|
571
|
+
color: #032f62;
|
|
572
|
+
} /* Literal.String.Doc */
|
|
573
|
+
.highlight .s2 {
|
|
574
|
+
color: #032f62;
|
|
575
|
+
} /* Literal.String.Double */
|
|
576
|
+
.highlight .se {
|
|
577
|
+
color: #032f62;
|
|
578
|
+
} /* Literal.String.Escape */
|
|
579
|
+
.highlight .sh {
|
|
580
|
+
color: #032f62;
|
|
581
|
+
} /* Literal.String.Heredoc */
|
|
582
|
+
.highlight .si {
|
|
583
|
+
color: #032f62;
|
|
584
|
+
} /* Literal.String.Interpol */
|
|
585
|
+
.highlight .sx {
|
|
586
|
+
color: #032f62;
|
|
587
|
+
} /* Literal.String.Other */
|
|
588
|
+
.highlight .sr {
|
|
589
|
+
color: #22863a;
|
|
590
|
+
} /* Literal.String.Regex */
|
|
591
|
+
.highlight .s1 {
|
|
592
|
+
color: #032f62;
|
|
593
|
+
} /* Literal.String.Single */
|
|
594
|
+
.highlight .ss {
|
|
595
|
+
color: #032f62;
|
|
596
|
+
} /* Literal.String.Symbol */
|
|
597
|
+
.highlight .bp {
|
|
598
|
+
color: #005cc5;
|
|
599
|
+
} /* Name.Builtin.Pseudo */
|
|
600
|
+
.highlight .vc {
|
|
601
|
+
color: #e36209;
|
|
602
|
+
} /* Name.Variable.Class */
|
|
603
|
+
.highlight .vg {
|
|
604
|
+
color: #e36209;
|
|
605
|
+
} /* Name.Variable.Global */
|
|
606
|
+
.highlight .vi {
|
|
607
|
+
color: #e36209;
|
|
608
|
+
} /* Name.Variable.Instance */
|
|
609
|
+
.highlight .il {
|
|
610
|
+
color: #005cc5;
|
|
611
|
+
} /* Literal.Number.Integer.Long */
|
|
612
|
+
|
|
613
|
+
/* Additional Rouge token classes that may be used */
|
|
614
|
+
.highlight .token {
|
|
615
|
+
color: #5670a0;
|
|
616
|
+
}
|
|
617
|
+
.highlight .token.list {
|
|
618
|
+
color: #546e9f;
|
|
619
|
+
}
|
|
620
|
+
.highlight .token.punctuation {
|
|
621
|
+
color: #3e8dad;
|
|
622
|
+
}
|
|
623
|
+
.highlight .token.list.punctuation {
|
|
624
|
+
color: #e05b78;
|
|
625
|
+
}
|
|
626
|
+
.highlight .token.content {
|
|
627
|
+
padding: 0;
|
|
628
|
+
}
|
|
629
|
+
|
|
630
|
+
/* Nested lists in page content */
|
|
631
|
+
ul ul,
|
|
632
|
+
ol ol,
|
|
633
|
+
ul ol,
|
|
634
|
+
ol ul {
|
|
635
|
+
padding-left: 1.5em;
|
|
636
|
+
margin-top: 0.25em;
|
|
637
|
+
}
|
|
638
|
+
|
|
639
|
+
/* Page footer */
|
|
640
|
+
.page-footer {
|
|
641
|
+
background: #f5f5f5;
|
|
642
|
+
border-top: 1px solid #ddd;
|
|
643
|
+
padding: 1.5rem;
|
|
644
|
+
margin-top: 3rem;
|
|
645
|
+
color: #666;
|
|
646
|
+
font-size: 0.9em;
|
|
647
|
+
}
|
|
648
|
+
|
|
649
|
+
.page-footer p {
|
|
650
|
+
margin: 0.5em 0;
|
|
651
|
+
}
|
|
652
|
+
|
|
653
|
+
.page-footer a {
|
|
654
|
+
color: #0066cc;
|
|
655
|
+
text-decoration: none;
|
|
656
|
+
}
|
|
657
|
+
|
|
658
|
+
.page-footer a:hover {
|
|
659
|
+
text-decoration: underline;
|
|
660
|
+
}
|
|
661
|
+
|
|
662
|
+
/* Mobile responsive */
|
|
663
|
+
@media (max-width: 768px) {
|
|
664
|
+
.hamburger-menu {
|
|
665
|
+
display: flex;
|
|
666
|
+
}
|
|
667
|
+
|
|
668
|
+
.main-toc,
|
|
669
|
+
.sidebar {
|
|
670
|
+
transform: translateX(-100%);
|
|
671
|
+
z-index: 175;
|
|
672
|
+
}
|
|
673
|
+
|
|
674
|
+
.main-toc.mobile-open,
|
|
675
|
+
.sidebar.mobile-open {
|
|
676
|
+
transform: translateX(0);
|
|
677
|
+
}
|
|
678
|
+
|
|
679
|
+
body {
|
|
680
|
+
margin-left: 0;
|
|
681
|
+
}
|
|
682
|
+
|
|
683
|
+
.floating-toc {
|
|
684
|
+
left: 0;
|
|
685
|
+
}
|
|
686
|
+
}
|
|
687
|
+
|
|
688
|
+
</style></head>
|
|
689
|
+
|
|
690
|
+
<body>
|
|
691
|
+
<div class="floating-toc" id="floating-toc">
|
|
692
|
+
<div class="floating-toc-container">
|
|
693
|
+
<div class="floating-toc-header">
|
|
694
|
+
<span>Table of Contents 🔻</span>
|
|
695
|
+
</div>
|
|
696
|
+
<div class="floating-toc-content" id="floating-toc-content">
|
|
697
|
+
<!-- Content will be populated by JavaScript -->
|
|
698
|
+
</div>
|
|
699
|
+
</div>
|
|
700
|
+
</div>
|
|
701
|
+
|
|
702
|
+
<button class="hamburger-menu" id="hamburger-menu" aria-label="Toggle navigation"></button>
|
|
703
|
+
<div class="mobile-menu-overlay" id="mobile-menu-overlay"></div>
|
|
704
|
+
|
|
705
|
+
<nav class="main-toc"><ul><li><a href="Home.html">Home</a></li><li><a href="Getting-Started.html">Getting Started</a></li><li><a href="Installation.html">Installation</a></li><li><a href="Usage.html">Usage</a></li><li><a href="Syntax.html">Syntax</a></li><li><a href="Inline-Attribute-Lists.html">Inline Attribute Lists</a></li><li><a href="Modes.html">Modes</a></li><li><a href="Command-Line-Options.html">Command Line Options</a></li><li><a href="Multi-File-Documents.html">Multi-file Documents</a></li><li><a href="Citations.html">Citations</a></li><li><a href="Metadata-Transforms.html">Metadata Transforms</a></li><li><a href="Pandoc-Integration.html">Integrating with Pandoc</a></li><li><a href="Header-IDs.html">Header IDs</a></li><li><a href="C-API.html">C API</a></li><li><a href="Xcode-Integration.html">Xcode Integration</a></li><li><a href="Examples.html">Examples</a></li><li><a href="Plugins.html">Plugins</a></li><li><a href="Troubleshooting.html">Troubleshooting</a></li><li><a href="Credits.html">Credits</a></li></ul></nav>
|
|
706
|
+
|
|
707
|
+
<h1 id="citations-and-bibliography">
|
|
708
|
+
Citations and Bibliography
|
|
709
|
+
</h1>
|
|
710
|
+
<nav class="page-toc" id="page-toc-top"><ul><li><a href="#citations-and-bibliography">Citations and Bibliography</a><ul><li><a href="#quick-start">Quick Start</a></li><li><a href="#citation-syntaxes">Citation Syntaxes</a><ul><li><a href="#pandoc-syntax">Pandoc Syntax</a></li><li><a href="#multimarkdown-syntax">MultiMarkdown Syntax</a></li><li><a href="#mmark-syntax">mmark Syntax</a></li></ul></li><li><a href="#bibliography-formats">Bibliography Formats</a><ul><li><a href="#bibtex-bib">BibTeX (.bib)</a></li><li><a href="#csl-json-json">CSL JSON (.json)</a></li><li><a href="#csl-yaml-yml-yaml">CSL YAML (.yml, .yaml)</a></li></ul></li><li><a href="#specifying-bibliography">Specifying Bibliography</a><ul><li><a href="#command-line">Command Line</a></li><li><a href="#document-metadata">Document Metadata</a></li></ul></li><li><a href="#bibliography-generation">Bibliography Generation</a></li><li><a href="#citation-options">Citation Options</a><ul><li><a href="#link-citations">Link Citations</a></li><li><a href="#suppress-bibliography">Suppress Bibliography</a></li><li><a href="#citation-style-csl">Citation Style (CSL)</a></li></ul></li><li><a href="#mode-support">Mode Support</a></li><li><a href="#performance">Performance</a></li><li><a href="#related">Related</a></li></ul></li></ul></nav>
|
|
711
|
+
|
|
712
|
+
<p>
|
|
713
|
+
Apex supports citations and bibliographies with multiple syntax styles and bibliography formats. Citations are processed in <strong>MultiMarkdown</strong> and <strong>unified</strong> modes.
|
|
714
|
+
</p>
|
|
715
|
+
|
|
716
|
+
<h2 id="quick-start">
|
|
717
|
+
Quick Start
|
|
718
|
+
</h2>
|
|
719
|
+
|
|
720
|
+
<p>
|
|
721
|
+
<strong> 1. Create a bibliography file:</strong>
|
|
722
|
+
</p>
|
|
723
|
+
|
|
724
|
+
<p>
|
|
725
|
+
Create a BibTeX file (<code>references.bib</code>):
|
|
726
|
+
</p>
|
|
727
|
+
|
|
728
|
+
<pre><code class="highlight language-bibtex"><span class="nc">@article</span><span class="p">{</span><span class="nl">doe99</span><span class="p">,</span>
|
|
729
|
+
<span class="na">author</span> <span class="p">=</span> <span class="s">{Doe, John}</span><span class="p">,</span>
|
|
730
|
+
<span class="na">title</span> <span class="p">=</span> <span class="s">{Article Title}</span><span class="p">,</span>
|
|
731
|
+
<span class="na">journal</span> <span class="p">=</span> <span class="s">{Journal Name}</span><span class="p">,</span>
|
|
732
|
+
<span class="na">year</span> <span class="p">=</span> <span class="s">{1999}</span><span class="p">,</span>
|
|
733
|
+
<span class="na">volume</span> <span class="p">=</span> <span class="s">{1}</span><span class="p">,</span>
|
|
734
|
+
<span class="na">pages</span> <span class="p">=</span> <span class="s">{1--10}</span>
|
|
735
|
+
<span class="p">}</span>
|
|
736
|
+
|
|
737
|
+
<span class="nc">@book</span><span class="p">{</span><span class="nl">smith2000</span><span class="p">,</span>
|
|
738
|
+
<span class="na">author</span> <span class="p">=</span> <span class="s">{Smith, Jane}</span><span class="p">,</span>
|
|
739
|
+
<span class="na">title</span> <span class="p">=</span> <span class="s">{Book Title}</span><span class="p">,</span>
|
|
740
|
+
<span class="na">publisher</span> <span class="p">=</span> <span class="s">{Publisher}</span><span class="p">,</span>
|
|
741
|
+
<span class="na">year</span> <span class="p">=</span> <span class="s">{2000}</span>
|
|
742
|
+
<span class="p">}</span>
|
|
743
|
+
</code></pre>
|
|
744
|
+
|
|
745
|
+
<p>
|
|
746
|
+
<strong> 2. Add citations to your document:</strong>
|
|
747
|
+
</p>
|
|
748
|
+
|
|
749
|
+
<pre><code class="highlight language-markdown"><span class="nn">---</span>
|
|
750
|
+
<span class="na">bibliography</span><span class="pi">:</span> <span class="s">references.bib</span>
|
|
751
|
+
<span class="nn">---</span>
|
|
752
|
+
|
|
753
|
+
See [@doe99] for details. Smith discusses this in [@smith2000].
|
|
754
|
+
|
|
755
|
+
<span class="gu">## References</span>
|
|
756
|
+
|
|
757
|
+
<span class="c"><!-- REFERENCES --></span>
|
|
758
|
+
</code></pre>
|
|
759
|
+
|
|
760
|
+
<p>
|
|
761
|
+
<strong> 3. Process with Apex:</strong>
|
|
762
|
+
</p>
|
|
763
|
+
|
|
764
|
+
<pre><code class="highlight language-bash">apex document.md <span class="nt">--bibliography</span> references.bib
|
|
765
|
+
</code></pre>
|
|
766
|
+
|
|
767
|
+
<p>
|
|
768
|
+
Or specify in metadata (as shown above) and just run:
|
|
769
|
+
</p>
|
|
770
|
+
|
|
771
|
+
<pre><code class="highlight language-bash">apex document.md
|
|
772
|
+
</code></pre>
|
|
773
|
+
|
|
774
|
+
<h2 id="citation-syntaxes">
|
|
775
|
+
Citation Syntaxes
|
|
776
|
+
</h2>
|
|
777
|
+
|
|
778
|
+
<p>
|
|
779
|
+
Apex supports three citation syntax styles, automatically detected in unified mode:
|
|
780
|
+
</p>
|
|
781
|
+
|
|
782
|
+
<h3 id="pandoc-syntax">
|
|
783
|
+
Pandoc Syntax
|
|
784
|
+
</h3>
|
|
785
|
+
|
|
786
|
+
<p>
|
|
787
|
+
Pandoc-style citations use square brackets with <code>@</code> prefix:
|
|
788
|
+
</p>
|
|
789
|
+
|
|
790
|
+
<p>
|
|
791
|
+
<strong> Basic citation:</strong>
|
|
792
|
+
</p>
|
|
793
|
+
|
|
794
|
+
<pre><code class="highlight language-markdown">See [@doe99] for details.
|
|
795
|
+
</code></pre>
|
|
796
|
+
|
|
797
|
+
<p>
|
|
798
|
+
<strong> Multiple citations:</strong>
|
|
799
|
+
</p>
|
|
800
|
+
|
|
801
|
+
<pre><code class="highlight language-markdown">See [@doe99; @smith2000; @smith2004] for more information.
|
|
802
|
+
</code></pre>
|
|
803
|
+
|
|
804
|
+
<p>
|
|
805
|
+
<strong> Author in text:</strong>
|
|
806
|
+
</p>
|
|
807
|
+
|
|
808
|
+
<pre><code class="highlight language-markdown">@smith04 says blah.
|
|
809
|
+
</code></pre>
|
|
810
|
+
|
|
811
|
+
<p>
|
|
812
|
+
<strong> Author suppressed (year only):</strong>
|
|
813
|
+
</p>
|
|
814
|
+
|
|
815
|
+
<pre><code class="highlight language-markdown">Smith says blah [-@smith04].
|
|
816
|
+
</code></pre>
|
|
817
|
+
|
|
818
|
+
<p>
|
|
819
|
+
<strong> With locator (page numbers):</strong>
|
|
820
|
+
</p>
|
|
821
|
+
|
|
822
|
+
<pre><code class="highlight language-markdown">@smith04 [p. 33] says blah.
|
|
823
|
+
See @doe99, pp. 33-35 and <span class="ge">*passim*</span>.
|
|
824
|
+
</code></pre>
|
|
825
|
+
|
|
826
|
+
<p>
|
|
827
|
+
<strong> Output:</strong>
|
|
828
|
+
</p>
|
|
829
|
+
|
|
830
|
+
<pre><code class="highlight language-html"><span class="nt"><p></span>See <span class="nt"><span</span> <span class="na">class=</span><span class="s">"citation"</span> <span class="na">data-cites=</span><span class="s">"doe99"</span><span class="nt">></span>(Doe, John 1999)<span class="nt"></span></span> for details.<span class="nt"></p></span>
|
|
831
|
+
<span class="nt"><p></span>See <span class="nt"><span</span> <span class="na">class=</span><span class="s">"citation"</span> <span class="na">data-cites=</span><span class="s">"doe99 smith2000 smith2004"</span><span class="nt">></span>(Doe, John 1999; Smith, Jane 2000, 2004)<span class="nt"></span></span> for more information.<span class="nt"></p></span>
|
|
832
|
+
<span class="nt"><p><span</span> <span class="na">class=</span><span class="s">"citation"</span> <span class="na">data-cites=</span><span class="s">"smith04"</span><span class="nt">></span>Smith, John (2004)<span class="nt"></span></span> says blah.<span class="nt"></p></span>
|
|
833
|
+
<span class="nt"><p></span>Smith says blah <span class="nt"><span</span> <span class="na">class=</span><span class="s">"citation"</span> <span class="na">data-cites=</span><span class="s">"smith04"</span><span class="nt">></span>(2004)<span class="nt"></span></span>.<span class="nt"></p></span>
|
|
834
|
+
</code></pre>
|
|
835
|
+
|
|
836
|
+
<h3 id="multimarkdown-syntax">
|
|
837
|
+
MultiMarkdown Syntax
|
|
838
|
+
</h3>
|
|
839
|
+
|
|
840
|
+
<p>
|
|
841
|
+
MultiMarkdown-style citations use <code>#</code> prefix:
|
|
842
|
+
</p>
|
|
843
|
+
|
|
844
|
+
<p>
|
|
845
|
+
<strong> Basic citation:</strong>
|
|
846
|
+
</p>
|
|
847
|
+
|
|
848
|
+
<pre><code class="highlight language-markdown">This is a statement[#Doe:2006].
|
|
849
|
+
</code></pre>
|
|
850
|
+
|
|
851
|
+
<p>
|
|
852
|
+
<strong> With locator:</strong>
|
|
853
|
+
</p>
|
|
854
|
+
|
|
855
|
+
<pre><code class="highlight language-markdown">This is a statement<span class="p">[</span><span class="nv">p. 23</span><span class="p">][</span><span class="ss">#Doe:2006</span><span class="p">]</span>.
|
|
856
|
+
</code></pre>
|
|
857
|
+
|
|
858
|
+
<p>
|
|
859
|
+
<strong> Empty locator:</strong>
|
|
860
|
+
</p>
|
|
861
|
+
|
|
862
|
+
<pre><code class="highlight language-markdown">This is a statement<span class="p">[][</span><span class="ss">#Doe:2006</span><span class="p">]</span>.
|
|
863
|
+
</code></pre>
|
|
864
|
+
|
|
865
|
+
<p>
|
|
866
|
+
<strong> Inline citation:</strong>
|
|
867
|
+
</p>
|
|
868
|
+
|
|
869
|
+
<pre><code class="highlight language-markdown">As per Doe.[#John Doe. <span class="ge">*A Totally Fake Book 1*</span>. Vanity Press, 2006.]
|
|
870
|
+
</code></pre>
|
|
871
|
+
|
|
872
|
+
<p>
|
|
873
|
+
<strong> Output:</strong>
|
|
874
|
+
</p>
|
|
875
|
+
|
|
876
|
+
<pre><code class="highlight language-html"><span class="nt"><p></span>This is a statement<span class="nt"><span</span> <span class="na">class=</span><span class="s">"citation"</span> <span class="na">data-cites=</span><span class="s">"Doe:2006"</span><span class="nt">></span>(Doe:2006)<span class="nt"></span></span>.<span class="nt"></p></span>
|
|
877
|
+
<span class="nt"><p></span>This is a statement[p. 23]<span class="nt"><span</span> <span class="na">class=</span><span class="s">"citation"</span> <span class="na">data-cites=</span><span class="s">"Doe:2006"</span><span class="nt">></span>(Doe:2006)<span class="nt"></span></span>.<span class="nt"></p></span>
|
|
878
|
+
</code></pre>
|
|
879
|
+
|
|
880
|
+
<h3 id="mmark-syntax">
|
|
881
|
+
mmark Syntax
|
|
882
|
+
</h3>
|
|
883
|
+
|
|
884
|
+
<p>
|
|
885
|
+
mmark-style citations use <code>@</code> prefix (similar to Pandoc but with different conventions):
|
|
886
|
+
</p>
|
|
887
|
+
|
|
888
|
+
<p>
|
|
889
|
+
<strong> Basic citation:</strong>
|
|
890
|
+
</p>
|
|
891
|
+
|
|
892
|
+
<pre><code class="highlight language-markdown">This references [@RFC2535].
|
|
893
|
+
</code></pre>
|
|
894
|
+
|
|
895
|
+
<p>
|
|
896
|
+
<strong> Normative citation:</strong>
|
|
897
|
+
</p>
|
|
898
|
+
|
|
899
|
+
<pre><code class="highlight language-markdown">This references [@!RFC1034] (normative).
|
|
900
|
+
</code></pre>
|
|
901
|
+
|
|
902
|
+
<p>
|
|
903
|
+
<strong> Multiple citations:</strong>
|
|
904
|
+
</p>
|
|
905
|
+
|
|
906
|
+
<pre><code class="highlight language-markdown">Multiple citations: [@RFC1034;@RFC1035].
|
|
907
|
+
</code></pre>
|
|
908
|
+
|
|
909
|
+
<p>
|
|
910
|
+
<strong> Combined reference:</strong>
|
|
911
|
+
</p>
|
|
912
|
+
|
|
913
|
+
<pre><code class="highlight language-markdown">Combined reference: [@RFC1034@STD3].
|
|
914
|
+
</code></pre>
|
|
915
|
+
|
|
916
|
+
<p>
|
|
917
|
+
<strong> Output:</strong>
|
|
918
|
+
</p>
|
|
919
|
+
|
|
920
|
+
<pre><code class="highlight language-html"><span class="nt"><p></span>This references <span class="nt"><span</span> <span class="na">class=</span><span class="s">"citation"</span> <span class="na">data-cites=</span><span class="s">"RFC2535"</span><span class="nt">></span>(RFC2535)<span class="nt"></span></span>.<span class="nt"></p></span>
|
|
921
|
+
<span class="nt"><p></span>Multiple citations: <span class="nt"><span</span> <span class="na">class=</span><span class="s">"citation"</span> <span class="na">data-cites=</span><span class="s">"RFC1034"</span><span class="nt">></span>(RFC1034)<span class="nt"></span></span>;<span class="nt"><span</span> <span class="na">class=</span><span class="s">"citation"</span> <span class="na">data-cites=</span><span class="s">"RFC1035"</span><span class="nt">></span>(RFC1035)<span class="nt"></span></span>.<span class="nt"></p></span>
|
|
922
|
+
</code></pre>
|
|
923
|
+
|
|
924
|
+
<h2 id="bibliography-formats">
|
|
925
|
+
Bibliography Formats
|
|
926
|
+
</h2>
|
|
927
|
+
|
|
928
|
+
<p>
|
|
929
|
+
Apex supports three bibliography formats:
|
|
930
|
+
</p>
|
|
931
|
+
|
|
932
|
+
<h3 id="bibtex-bib">
|
|
933
|
+
BibTeX (<code>.bib</code>)
|
|
934
|
+
</h3>
|
|
935
|
+
|
|
936
|
+
<p>
|
|
937
|
+
Standard BibTeX format:
|
|
938
|
+
</p>
|
|
939
|
+
|
|
940
|
+
<pre><code class="highlight language-bibtex"><span class="nc">@article</span><span class="p">{</span><span class="nl">doe99</span><span class="p">,</span>
|
|
941
|
+
<span class="na">author</span> <span class="p">=</span> <span class="s">{Doe, John}</span><span class="p">,</span>
|
|
942
|
+
<span class="na">title</span> <span class="p">=</span> <span class="s">{Article Title}</span><span class="p">,</span>
|
|
943
|
+
<span class="na">journal</span> <span class="p">=</span> <span class="s">{Journal Name}</span><span class="p">,</span>
|
|
944
|
+
<span class="na">year</span> <span class="p">=</span> <span class="s">{1999}</span><span class="p">,</span>
|
|
945
|
+
<span class="na">volume</span> <span class="p">=</span> <span class="s">{1}</span><span class="p">,</span>
|
|
946
|
+
<span class="na">pages</span> <span class="p">=</span> <span class="s">{1--10}</span>
|
|
947
|
+
<span class="p">}</span>
|
|
948
|
+
|
|
949
|
+
<span class="nc">@book</span><span class="p">{</span><span class="nl">smith2000</span><span class="p">,</span>
|
|
950
|
+
<span class="na">author</span> <span class="p">=</span> <span class="s">{Smith, Jane}</span><span class="p">,</span>
|
|
951
|
+
<span class="na">title</span> <span class="p">=</span> <span class="s">{Book Title}</span><span class="p">,</span>
|
|
952
|
+
<span class="na">publisher</span> <span class="p">=</span> <span class="s">{Publisher}</span><span class="p">,</span>
|
|
953
|
+
<span class="na">year</span> <span class="p">=</span> <span class="s">{2000}</span>
|
|
954
|
+
<span class="p">}</span>
|
|
955
|
+
</code></pre>
|
|
956
|
+
|
|
957
|
+
<h3 id="csl-json-json">
|
|
958
|
+
CSL JSON (<code>.json</code>)
|
|
959
|
+
</h3>
|
|
960
|
+
|
|
961
|
+
<p>
|
|
962
|
+
Citation Style Language JSON format:
|
|
963
|
+
</p>
|
|
964
|
+
|
|
965
|
+
<pre><code class="highlight language-json"><span class="p">[</span><span class="w">
|
|
966
|
+
</span><span class="p">{</span><span class="w">
|
|
967
|
+
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"doe99"</span><span class="p">,</span><span class="w">
|
|
968
|
+
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"article-journal"</span><span class="p">,</span><span class="w">
|
|
969
|
+
</span><span class="nl">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Article Title"</span><span class="p">,</span><span class="w">
|
|
970
|
+
</span><span class="nl">"author"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
|
971
|
+
</span><span class="p">{</span><span class="w">
|
|
972
|
+
</span><span class="nl">"family"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Doe"</span><span class="p">,</span><span class="w">
|
|
973
|
+
</span><span class="nl">"given"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="w">
|
|
974
|
+
</span><span class="p">}</span><span class="w">
|
|
975
|
+
</span><span class="p">],</span><span class="w">
|
|
976
|
+
</span><span class="nl">"container-title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Journal Name"</span><span class="p">,</span><span class="w">
|
|
977
|
+
</span><span class="nl">"issued"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
|
978
|
+
</span><span class="nl">"date-parts"</span><span class="p">:</span><span class="w"> </span><span class="p">[[</span><span class="mi">1999</span><span class="p">]]</span><span class="w">
|
|
979
|
+
</span><span class="p">},</span><span class="w">
|
|
980
|
+
</span><span class="nl">"volume"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1"</span><span class="p">,</span><span class="w">
|
|
981
|
+
</span><span class="nl">"page"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1-10"</span><span class="w">
|
|
982
|
+
</span><span class="p">}</span><span class="w">
|
|
983
|
+
</span><span class="p">]</span><span class="w">
|
|
984
|
+
</span></code></pre>
|
|
985
|
+
|
|
986
|
+
<h3 id="csl-yaml-yml-yaml">
|
|
987
|
+
CSL YAML (<code>.yml</code>, <code>.yaml</code>)
|
|
988
|
+
</h3>
|
|
989
|
+
|
|
990
|
+
<p>
|
|
991
|
+
Citation Style Language YAML format:
|
|
992
|
+
</p>
|
|
993
|
+
|
|
994
|
+
<pre><code class="highlight language-yaml"><span class="pi">-</span> <span class="na">id</span><span class="pi">:</span> <span class="s">doe99</span>
|
|
995
|
+
<span class="na">type</span><span class="pi">:</span> <span class="s">article-journal</span>
|
|
996
|
+
<span class="na">title</span><span class="pi">:</span> <span class="s">Article Title</span>
|
|
997
|
+
<span class="na">author</span><span class="pi">:</span>
|
|
998
|
+
<span class="pi">-</span> <span class="na">family</span><span class="pi">:</span> <span class="s">Doe</span>
|
|
999
|
+
<span class="na">given</span><span class="pi">:</span> <span class="s">John</span>
|
|
1000
|
+
<span class="na">container-title</span><span class="pi">:</span> <span class="s">Journal Name</span>
|
|
1001
|
+
<span class="na">issued</span><span class="pi">:</span>
|
|
1002
|
+
<span class="na">date-parts</span><span class="pi">:</span>
|
|
1003
|
+
<span class="pi">-</span> <span class="pi">-</span> <span class="m">1999</span>
|
|
1004
|
+
<span class="na">volume</span><span class="pi">:</span> <span class="m">1</span>
|
|
1005
|
+
<span class="na">page</span><span class="pi">:</span> <span class="s">1-10</span>
|
|
1006
|
+
</code></pre>
|
|
1007
|
+
|
|
1008
|
+
<h2 id="specifying-bibliography">
|
|
1009
|
+
Specifying Bibliography
|
|
1010
|
+
</h2>
|
|
1011
|
+
|
|
1012
|
+
<h3 id="command-line">
|
|
1013
|
+
Command Line
|
|
1014
|
+
</h3>
|
|
1015
|
+
|
|
1016
|
+
<pre><code class="highlight language-bash"><span class="c"># Single file</span>
|
|
1017
|
+
apex document.md <span class="nt">--bibliography</span> references.bib
|
|
1018
|
+
|
|
1019
|
+
<span class="c"># Multiple files</span>
|
|
1020
|
+
apex document.md <span class="nt">--bibliography</span> refs1.bib <span class="nt">--bibliography</span> refs2.bib
|
|
1021
|
+
|
|
1022
|
+
<span class="c"># With base directory</span>
|
|
1023
|
+
apex document.md <span class="nt">--bibliography</span> refs.bib <span class="nt">--base-dir</span> /path/to/docs
|
|
1024
|
+
</code></pre>
|
|
1025
|
+
|
|
1026
|
+
<h3 id="document-metadata">
|
|
1027
|
+
Document Metadata
|
|
1028
|
+
</h3>
|
|
1029
|
+
|
|
1030
|
+
<p>
|
|
1031
|
+
<strong> YAML front matter:</strong>
|
|
1032
|
+
</p>
|
|
1033
|
+
|
|
1034
|
+
<pre><code class="highlight language-markdown"><span class="nn">---</span>
|
|
1035
|
+
<span class="na">bibliography</span><span class="pi">:</span> <span class="s">references.bib</span>
|
|
1036
|
+
<span class="nn">---</span>
|
|
1037
|
+
|
|
1038
|
+
See [@doe99] for details.
|
|
1039
|
+
</code></pre>
|
|
1040
|
+
|
|
1041
|
+
<p>
|
|
1042
|
+
<strong> Multiple files:</strong>
|
|
1043
|
+
</p>
|
|
1044
|
+
|
|
1045
|
+
<pre><code class="highlight language-markdown"><span class="nn">---</span>
|
|
1046
|
+
<span class="na">bibliography</span><span class="pi">:</span>
|
|
1047
|
+
<span class="pi">-</span> <span class="s">refs1.bib</span>
|
|
1048
|
+
<span class="pi">-</span> <span class="s">refs2.bib</span>
|
|
1049
|
+
<span class="nn">---</span>
|
|
1050
|
+
|
|
1051
|
+
See [@doe99] for details.
|
|
1052
|
+
</code></pre>
|
|
1053
|
+
|
|
1054
|
+
<p>
|
|
1055
|
+
<strong> MultiMarkdown metadata:</strong>
|
|
1056
|
+
</p>
|
|
1057
|
+
|
|
1058
|
+
<pre><code class="highlight language-markdown">Bibliography: references.bib
|
|
1059
|
+
|
|
1060
|
+
See [@doe99] for details.
|
|
1061
|
+
</code></pre>
|
|
1062
|
+
|
|
1063
|
+
<p>
|
|
1064
|
+
<strong> Pandoc title block:</strong>
|
|
1065
|
+
</p>
|
|
1066
|
+
|
|
1067
|
+
<pre><code class="highlight language-markdown">% Bibliography: references.bib
|
|
1068
|
+
|
|
1069
|
+
See [@doe99] for details.
|
|
1070
|
+
</code></pre>
|
|
1071
|
+
|
|
1072
|
+
<h2 id="bibliography-generation">
|
|
1073
|
+
Bibliography Generation
|
|
1074
|
+
</h2>
|
|
1075
|
+
|
|
1076
|
+
<p>
|
|
1077
|
+
Bibliography is automatically generated from all cited entries and inserted at the <code><!-- REFERENCES --></code> marker:
|
|
1078
|
+
</p>
|
|
1079
|
+
|
|
1080
|
+
<pre><code class="highlight language-markdown">See [@doe99] and [@smith2000] for details.
|
|
1081
|
+
|
|
1082
|
+
<span class="gu">## References</span>
|
|
1083
|
+
|
|
1084
|
+
<span class="c"><!-- REFERENCES --></span>
|
|
1085
|
+
</code></pre>
|
|
1086
|
+
|
|
1087
|
+
<p>
|
|
1088
|
+
<strong> Output:</strong>
|
|
1089
|
+
</p>
|
|
1090
|
+
|
|
1091
|
+
<pre><code class="highlight language-html"><span class="nt"><p></span>See <span class="nt"><span</span> <span class="na">class=</span><span class="s">"citation"</span> <span class="na">data-cites=</span><span class="s">"doe99"</span><span class="nt">></span>(Doe, John 1999)<span class="nt"></span></span> and <span class="nt"><span</span> <span class="na">class=</span><span class="s">"citation"</span> <span class="na">data-cites=</span><span class="s">"smith2000"</span><span class="nt">></span>(Smith, Jane 2000)<span class="nt"></span></span> for details.<span class="nt"></p></span>
|
|
1092
|
+
|
|
1093
|
+
<span class="nt"><h2></span>References<span class="nt"></h2></span>
|
|
1094
|
+
<span class="nt"><div</span> <span class="na">id=</span><span class="s">"refs"</span> <span class="na">class=</span><span class="s">"references csl-bib-body"</span><span class="nt">></span>
|
|
1095
|
+
<span class="nt"><div</span> <span class="na">id=</span><span class="s">"ref-doe99"</span> <span class="na">class=</span><span class="s">"csl-entry"</span><span class="nt">></span>Doe, John 1999. <span class="nt"><em></span>Article Title<span class="nt"></em></span>. <span class="nt"><em></span>Journal Name<span class="nt"></em></span> 1: 1--10<span class="nt"></div></span>
|
|
1096
|
+
<span class="nt"><div</span> <span class="na">id=</span><span class="s">"ref-smith2000"</span> <span class="na">class=</span><span class="s">"csl-entry"</span><span class="nt">></span>Smith, Jane 2000. <span class="nt"><em></span>Book Title<span class="nt"></em></span>. Publisher<span class="nt"></div></span>
|
|
1097
|
+
<span class="nt"></div></span>
|
|
1098
|
+
</code></pre>
|
|
1099
|
+
|
|
1100
|
+
<p>
|
|
1101
|
+
If no <code><!-- REFERENCES --></code> marker is found, the bibliography is appended to the end of the document.
|
|
1102
|
+
</p>
|
|
1103
|
+
|
|
1104
|
+
<h2 id="citation-options">
|
|
1105
|
+
Citation Options
|
|
1106
|
+
</h2>
|
|
1107
|
+
|
|
1108
|
+
<h3 id="link-citations">
|
|
1109
|
+
Link Citations
|
|
1110
|
+
</h3>
|
|
1111
|
+
|
|
1112
|
+
<p>
|
|
1113
|
+
Use <code>--link-citations</code> to make citations link to their bibliography entries:
|
|
1114
|
+
</p>
|
|
1115
|
+
|
|
1116
|
+
<pre><code class="highlight language-bash">apex document.md <span class="nt">--bibliography</span> refs.bib <span class="nt">--link-citations</span>
|
|
1117
|
+
</code></pre>
|
|
1118
|
+
|
|
1119
|
+
<p>
|
|
1120
|
+
<strong> Output:</strong>
|
|
1121
|
+
</p>
|
|
1122
|
+
|
|
1123
|
+
<pre><code class="highlight language-html"><span class="nt"><p></span>See <span class="nt"><a</span> <span class="na">href=</span><span class="s">"#ref-doe99"</span> <span class="na">class=</span><span class="s">"citation"</span> <span class="na">data-cites=</span><span class="s">"doe99"</span><span class="nt">></span>(Doe, John 1999)<span class="nt"></a></span> for details.<span class="nt"></p></span>
|
|
1124
|
+
</code></pre>
|
|
1125
|
+
|
|
1126
|
+
<h3 id="suppress-bibliography">
|
|
1127
|
+
Suppress Bibliography
|
|
1128
|
+
</h3>
|
|
1129
|
+
|
|
1130
|
+
<p>
|
|
1131
|
+
Use <code>--no-bibliography</code> to suppress bibliography output while still processing citations:
|
|
1132
|
+
</p>
|
|
1133
|
+
|
|
1134
|
+
<pre><code class="highlight language-bash">apex document.md <span class="nt">--bibliography</span> refs.bib <span class="nt">--no-bibliography</span>
|
|
1135
|
+
</code></pre>
|
|
1136
|
+
|
|
1137
|
+
<h3 id="citation-style-csl">
|
|
1138
|
+
Citation Style (CSL)
|
|
1139
|
+
</h3>
|
|
1140
|
+
|
|
1141
|
+
<p>
|
|
1142
|
+
Specify a Citation Style Language file to control citation and bibliography formatting:
|
|
1143
|
+
</p>
|
|
1144
|
+
|
|
1145
|
+
<pre><code class="highlight language-bash">apex document.md <span class="nt">--bibliography</span> refs.bib <span class="nt">--csl</span> apa.csl
|
|
1146
|
+
</code></pre>
|
|
1147
|
+
|
|
1148
|
+
<p>
|
|
1149
|
+
CSL files can also be specified in metadata:
|
|
1150
|
+
</p>
|
|
1151
|
+
|
|
1152
|
+
<pre><code class="highlight language-markdown"><span class="nn">---</span>
|
|
1153
|
+
<span class="na">bibliography</span><span class="pi">:</span> <span class="s">refs.bib</span>
|
|
1154
|
+
<span class="na">csl</span><span class="pi">:</span> <span class="s">apa.csl</span>
|
|
1155
|
+
<span class="nn">---</span>
|
|
1156
|
+
</code></pre>
|
|
1157
|
+
|
|
1158
|
+
<h2 id="mode-support">
|
|
1159
|
+
Mode Support
|
|
1160
|
+
</h2>
|
|
1161
|
+
|
|
1162
|
+
<p>
|
|
1163
|
+
<strong> Unified mode:</strong>
|
|
1164
|
+
</p>
|
|
1165
|
+
|
|
1166
|
+
<ul>
|
|
1167
|
+
|
|
1168
|
+
<li>
|
|
1169
|
+
All citation syntaxes supported (auto-detected)
|
|
1170
|
+
</li>
|
|
1171
|
+
|
|
1172
|
+
<li>
|
|
1173
|
+
All bibliography formats supported
|
|
1174
|
+
</li>
|
|
1175
|
+
|
|
1176
|
+
<li>
|
|
1177
|
+
Citations enabled by default when bibliography is provided
|
|
1178
|
+
</li>
|
|
1179
|
+
|
|
1180
|
+
</ul>
|
|
1181
|
+
|
|
1182
|
+
<p>
|
|
1183
|
+
<strong> MultiMarkdown mode:</strong>
|
|
1184
|
+
</p>
|
|
1185
|
+
|
|
1186
|
+
<ul>
|
|
1187
|
+
|
|
1188
|
+
<li>
|
|
1189
|
+
MultiMarkdown citation syntax (<code>[#key]</code>)
|
|
1190
|
+
</li>
|
|
1191
|
+
|
|
1192
|
+
<li>
|
|
1193
|
+
All bibliography formats supported
|
|
1194
|
+
</li>
|
|
1195
|
+
|
|
1196
|
+
<li>
|
|
1197
|
+
Citations enabled by default when bibliography is provided
|
|
1198
|
+
</li>
|
|
1199
|
+
|
|
1200
|
+
</ul>
|
|
1201
|
+
|
|
1202
|
+
<p>
|
|
1203
|
+
<strong> CommonMark/GFM modes:</strong>
|
|
1204
|
+
</p>
|
|
1205
|
+
|
|
1206
|
+
<ul>
|
|
1207
|
+
|
|
1208
|
+
<li>
|
|
1209
|
+
Citations disabled (pure CommonMark/GFM)
|
|
1210
|
+
</li>
|
|
1211
|
+
|
|
1212
|
+
</ul>
|
|
1213
|
+
|
|
1214
|
+
<p>
|
|
1215
|
+
<strong> Kramdown mode:</strong>
|
|
1216
|
+
</p>
|
|
1217
|
+
|
|
1218
|
+
<ul>
|
|
1219
|
+
|
|
1220
|
+
<li>
|
|
1221
|
+
Citations disabled (Kramdown uses different citation system)
|
|
1222
|
+
</li>
|
|
1223
|
+
|
|
1224
|
+
</ul>
|
|
1225
|
+
|
|
1226
|
+
<h2 id="performance">
|
|
1227
|
+
Performance
|
|
1228
|
+
</h2>
|
|
1229
|
+
|
|
1230
|
+
<p>
|
|
1231
|
+
Citations are only processed when a bibliography is actually provided (via <code>--bibliography</code> flag or metadata). This ensures no performance impact when citations aren’t being used.
|
|
1232
|
+
</p>
|
|
1233
|
+
|
|
1234
|
+
<h2 id="related">
|
|
1235
|
+
Related
|
|
1236
|
+
</h2>
|
|
1237
|
+
|
|
1238
|
+
<ul>
|
|
1239
|
+
|
|
1240
|
+
<li>
|
|
1241
|
+
<a href="Command-Line-Options.html"> Command Line Options</a> - Citation-related CLI flags
|
|
1242
|
+
</li>
|
|
1243
|
+
|
|
1244
|
+
<li>
|
|
1245
|
+
<a href="Syntax.html"> Syntax</a> - Citation syntax reference
|
|
1246
|
+
</li>
|
|
1247
|
+
|
|
1248
|
+
<li>
|
|
1249
|
+
<a href="Modes.html"> Modes</a> - Mode-specific citation support
|
|
1250
|
+
</li>
|
|
1251
|
+
|
|
1252
|
+
</ul>
|
|
1253
|
+
|
|
1254
|
+
<script>
|
|
1255
|
+
// Hamburger menu functionality
|
|
1256
|
+
(function() {
|
|
1257
|
+
function initHamburgerMenu() {
|
|
1258
|
+
var hamburger = document.getElementById('hamburger-menu');
|
|
1259
|
+
var sidebar = document.querySelector('.main-toc, .sidebar');
|
|
1260
|
+
var overlay = document.getElementById('mobile-menu-overlay');
|
|
1261
|
+
|
|
1262
|
+
if (!hamburger || !sidebar) return;
|
|
1263
|
+
|
|
1264
|
+
function toggleMenu() {
|
|
1265
|
+
var isOpen = sidebar.classList.contains('mobile-open');
|
|
1266
|
+
if (isOpen) {
|
|
1267
|
+
sidebar.classList.remove('mobile-open');
|
|
1268
|
+
hamburger.classList.remove('active');
|
|
1269
|
+
if (overlay) overlay.classList.remove('active');
|
|
1270
|
+
} else {
|
|
1271
|
+
sidebar.classList.add('mobile-open');
|
|
1272
|
+
hamburger.classList.add('active');
|
|
1273
|
+
if (overlay) overlay.classList.add('active');
|
|
1274
|
+
}
|
|
1275
|
+
}
|
|
1276
|
+
|
|
1277
|
+
hamburger.addEventListener('click', function(e) {
|
|
1278
|
+
e.stopPropagation();
|
|
1279
|
+
toggleMenu();
|
|
1280
|
+
});
|
|
1281
|
+
|
|
1282
|
+
if (overlay) {
|
|
1283
|
+
overlay.addEventListener('click', function() {
|
|
1284
|
+
toggleMenu();
|
|
1285
|
+
});
|
|
1286
|
+
}
|
|
1287
|
+
|
|
1288
|
+
// Close menu when clicking on a sidebar link (mobile only)
|
|
1289
|
+
if (window.innerWidth <= 768) {
|
|
1290
|
+
var sidebarLinks = sidebar.querySelectorAll('a');
|
|
1291
|
+
sidebarLinks.forEach(function(link) {
|
|
1292
|
+
link.addEventListener('click', function() {
|
|
1293
|
+
setTimeout(function() {
|
|
1294
|
+
sidebar.classList.remove('mobile-open');
|
|
1295
|
+
hamburger.classList.remove('active');
|
|
1296
|
+
if (overlay) overlay.classList.remove('active');
|
|
1297
|
+
}, 100);
|
|
1298
|
+
});
|
|
1299
|
+
});
|
|
1300
|
+
}
|
|
1301
|
+
|
|
1302
|
+
// Close menu on window resize if going to desktop
|
|
1303
|
+
window.addEventListener('resize', function() {
|
|
1304
|
+
if (window.innerWidth > 768) {
|
|
1305
|
+
sidebar.classList.remove('mobile-open');
|
|
1306
|
+
hamburger.classList.remove('active');
|
|
1307
|
+
if (overlay) overlay.classList.remove('active');
|
|
1308
|
+
}
|
|
1309
|
+
});
|
|
1310
|
+
}
|
|
1311
|
+
|
|
1312
|
+
// Initialize when DOM is ready
|
|
1313
|
+
if (document.readyState === 'loading') {
|
|
1314
|
+
document.addEventListener('DOMContentLoaded', initHamburgerMenu);
|
|
1315
|
+
} else {
|
|
1316
|
+
initHamburgerMenu();
|
|
1317
|
+
}
|
|
1318
|
+
})();
|
|
1319
|
+
|
|
1320
|
+
</script>
|
|
1321
|
+
<script>
|
|
1322
|
+
(function() {
|
|
1323
|
+
// Clone the page TOC for floating TOC
|
|
1324
|
+
function initFloatingTOC() {
|
|
1325
|
+
var pageTOC = document.getElementById('page-toc-top');
|
|
1326
|
+
var floatingTOCContent = document.getElementById('floating-toc-content');
|
|
1327
|
+
var floatingTOC = document.getElementById('floating-toc');
|
|
1328
|
+
|
|
1329
|
+
if (!pageTOC || !floatingTOCContent || !floatingTOC) return;
|
|
1330
|
+
|
|
1331
|
+
// Clone the TOC structure
|
|
1332
|
+
var tocClone = pageTOC.cloneNode(true);
|
|
1333
|
+
tocClone.id = 'floating-toc-clone';
|
|
1334
|
+
floatingTOCContent.appendChild(tocClone);
|
|
1335
|
+
|
|
1336
|
+
// Update all links to use smooth scrolling
|
|
1337
|
+
var allTOCLinks = document.querySelectorAll('.page-toc a, .floating-toc-content a');
|
|
1338
|
+
allTOCLinks.forEach(function(link) {
|
|
1339
|
+
link.addEventListener('click', function(e) {
|
|
1340
|
+
var href = this.getAttribute('href');
|
|
1341
|
+
if (href && href.startsWith('#')) {
|
|
1342
|
+
e.preventDefault();
|
|
1343
|
+
var targetId = href.substring(1);
|
|
1344
|
+
var targetElement = document.getElementById(targetId);
|
|
1345
|
+
if (targetElement) {
|
|
1346
|
+
var offset = 20; // Offset from top
|
|
1347
|
+
|
|
1348
|
+
// Function to calculate absolute position from document top
|
|
1349
|
+
function getAbsoluteTop(element) {
|
|
1350
|
+
var top = 0;
|
|
1351
|
+
while (element) {
|
|
1352
|
+
top += element.offsetTop;
|
|
1353
|
+
element = element.offsetParent;
|
|
1354
|
+
}
|
|
1355
|
+
return top;
|
|
1356
|
+
}
|
|
1357
|
+
|
|
1358
|
+
var absoluteTop = getAbsoluteTop(targetElement);
|
|
1359
|
+
var scrollTop = window.pageYOffset || document.documentElement.scrollTop;
|
|
1360
|
+
var offsetPosition = absoluteTop - offset;
|
|
1361
|
+
|
|
1362
|
+
// Only scroll if we're not already at the target position
|
|
1363
|
+
if (Math.abs(scrollTop - offsetPosition) > 10) {
|
|
1364
|
+
window.scrollTo({
|
|
1365
|
+
top: Math.max(0, offsetPosition),
|
|
1366
|
+
behavior: 'smooth'
|
|
1367
|
+
});
|
|
1368
|
+
}
|
|
1369
|
+
|
|
1370
|
+
// Update URL hash without triggering scroll
|
|
1371
|
+
if (history.pushState) {
|
|
1372
|
+
history.pushState(null, null, href);
|
|
1373
|
+
}
|
|
1374
|
+
}
|
|
1375
|
+
}
|
|
1376
|
+
});
|
|
1377
|
+
});
|
|
1378
|
+
|
|
1379
|
+
// Handle scroll to show/hide floating TOC
|
|
1380
|
+
var tocTop = pageTOC.getBoundingClientRect().top + window.pageYOffset;
|
|
1381
|
+
var tocBottom = tocTop + pageTOC.offsetHeight;
|
|
1382
|
+
|
|
1383
|
+
function updateFloatingTOC() {
|
|
1384
|
+
var scrollY = window.pageYOffset || document.documentElement.scrollTop;
|
|
1385
|
+
|
|
1386
|
+
if (scrollY > tocBottom) {
|
|
1387
|
+
floatingTOC.classList.add('visible');
|
|
1388
|
+
} else {
|
|
1389
|
+
floatingTOC.classList.remove('visible');
|
|
1390
|
+
}
|
|
1391
|
+
}
|
|
1392
|
+
|
|
1393
|
+
// Throttle scroll events
|
|
1394
|
+
var ticking = false;
|
|
1395
|
+
window.addEventListener('scroll', function() {
|
|
1396
|
+
if (!ticking) {
|
|
1397
|
+
window.requestAnimationFrame(function() {
|
|
1398
|
+
updateFloatingTOC();
|
|
1399
|
+
ticking = false;
|
|
1400
|
+
});
|
|
1401
|
+
ticking = true;
|
|
1402
|
+
}
|
|
1403
|
+
});
|
|
1404
|
+
|
|
1405
|
+
// Initial check
|
|
1406
|
+
updateFloatingTOC();
|
|
1407
|
+
}
|
|
1408
|
+
|
|
1409
|
+
// Initialize when DOM is ready
|
|
1410
|
+
if (document.readyState === 'loading') {
|
|
1411
|
+
document.addEventListener('DOMContentLoaded', initFloatingTOC);
|
|
1412
|
+
} else {
|
|
1413
|
+
initFloatingTOC();
|
|
1414
|
+
}
|
|
1415
|
+
})();
|
|
1416
|
+
</script>
|
|
1417
|
+
<footer class="page-footer"><p>Copyright 2025 Brett Terpstra, All Rights Reserved | MIT License</p></footer></body>
|
|
1418
|
+
|
|
1419
|
+
</html>
|
|
1420
|
+
|