dartdoc_modern 1.1.5 copy "dartdoc_modern: ^1.1.5" to clipboard
dartdoc_modern: ^1.1.5 copied to clipboard

Fork of dartdoc with VitePress and Jaspr backends for generating modern API and guide documentation sites.

Use this package as an executable

Install it

You can install the package from the command line:

dart pub global activate dartdoc_modern

Use it

The package has the following executables:

$ dartdoc
$ dartdoc_modern
$ dartdoc_vitepress

Use this package as a library

Depend on it

Run this command:

With Dart:

 $ dart pub add dartdoc_modern

This will add a line like this to your package's pubspec.yaml (and run an implicit dart pub get):

dependencies:
  dartdoc_modern: ^1.1.5

Alternatively, your editor might support dart pub get. Check the docs for your editor to learn more.

Import it

Now in your Dart code, you can use:

import 'package:dartdoc_modern/dartdoc.dart';
import 'package:dartdoc_modern/options.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/app.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/dart_pad.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/dartdoc_modern_footer.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/docs_code_block.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/docs_dartpad_runtime.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/docs_dartpad_runtime_stub.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/docs_dartpad_runtime_web.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/docs_disclosure_runtime.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/docs_disclosure_runtime_stub.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/docs_disclosure_runtime_web.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/docs_header.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/docs_home_hero.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/docs_lightbox_runtime.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/docs_lightbox_runtime_stub.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/docs_lightbox_runtime_web.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/docs_mermaid_runtime.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/docs_mermaid_runtime_stub.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/docs_mermaid_runtime_web.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/docs_nav_link.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/docs_navigation_runtime.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/docs_navigation_runtime_stub.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/docs_navigation_runtime_web.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/docs_page_actions_runtime.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/docs_page_actions_runtime_stub.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/docs_page_actions_runtime_web.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/docs_search.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/docs_sidebar.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/docs_sidebar_toggle.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/docs_sidebar_toggle_runtime.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/docs_sidebar_toggle_runtime_stub.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/docs_sidebar_toggle_runtime_web.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/docs_sidebar_toggle_shared.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/docs_sidebar_toggle_stub.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/docs_sidebar_toggle_web.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/docs_theme_toggle.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/docs_toc_runtime.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/docs_toc_runtime_stub.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/docs_toc_runtime_web.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/components/mermaid_diagram.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/docs_base.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/extensions/api_linker_extension.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/extensions/base_path_link_extension.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/extensions/explicit_heading_ids_extension.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/layouts/api_docs_layout.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/layouts/docs_header_shell_styles.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/layouts/docs_home_layout.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/layouts/docs_search_styles.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/main.client.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/main.client.options.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/main.server.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/main.server.options.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/project_version_routes.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/template_engine/docs_template_engine.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/theme/docs_responsive.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/theme/docs_theme.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/highlighting.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/languages/bash.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/languages/common.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/languages/css.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/languages/dart.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/languages/diff.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/languages/dockerfile.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/languages/ini.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/languages/javascript.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/languages/json.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/languages/markdown.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/languages/plaintext.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/languages/shell.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/languages/sql.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/languages/typescript.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/languages/xml.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/languages/yaml.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/src/callbacks.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/src/common_modes.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/src/compile_keywords.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/src/compiled_language.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/src/compiled_mode.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/src/compiled_scope.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/src/const/literals.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/src/const/magic_numbers.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/src/const/regexes.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/src/domain_regex.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/src/domain_regexp_match.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/src/extension/before_match.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/src/extension/compiler_extensions.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/src/extension/multi_class.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/src/extension/reg_exp.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/src/highlightv2.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/src/html_renderer.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/src/language.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/src/language_definition_parts.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/src/languages/mathematica_symbols.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/src/mode.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/src/mode_compiler.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/src/multi_regex.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/src/node.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/src/nulls.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/src/response.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/src/result.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/src/tuple2.dart';
import 'package:dartdoc_modern/resources/jaspr/lib/vendor/highlighting/src/utils.dart';
2
likes
60
points
233
downloads

Publisher

unverified uploader

Weekly Downloads

Fork of dartdoc with VitePress and Jaspr backends for generating modern API and guide documentation sites.

Repository (GitHub)
View/report issues
Contributing

License

BSD-3-Clause (license)

Dependencies

analyzer, args, collection, crypto, dart_style, glob, html, http, jaspr, jaspr_content, jaspr_router, logging, markdown, meta, package_config, path, pub_semver, source_span, syntax_highlight_lite, universal_web, web, yaml

More

Packages that depend on dartdoc_modern