ex_doc-master.zip

  • s8_294341
    了解作者
  • 356KB
    文件大小
  • zip
    文件格式
  • 0
    收藏次数
  • VIP专享
    资源类型
  • 0
    下载次数
  • 2022-04-30 06:38
    上传日期
ExDoc ExDoc是一种为Elixir项目生成文档的工具。 要查看示例,。 要了解有关如何记录项目的信息,请参阅。 要查看所有受支持的选项,请参阅。 特征 ExDoc具有许多功能: 从您的API文档自动生成HTML和EPUB文档 支持自定义页面和指南(除了API参考) 支持侧边栏中的模块,功能和页面的自定义分组 生成可在线和离线访问HTML文档 响应式设计,内置布局的手机和平板电脑 生成的文档上的可自定义徽标 每个记录的条目都包含一个直接链接到源代码的链接 全文搜索 键盘快捷键(在现有文档中按?可以显示帮助对话框) 带有自动完成的支持(快速搜索s键盘快捷键) 转到快捷方式,以获取具有自动完成支持的所有HexDocs软件包文档( g键盘快捷键) 支持夜间模式(根据浏览器首选项自动检测) 将鼠标悬停在模块/功能的链接上时显示工具提示(适用于当前项目和跨项目) 版本下拉列
ex_doc-master.zip
内容介绍
# ExDoc [![Build Status](https://github.com/elixir-lang/ex_doc/workflows/CI/badge.svg)](https://github.com/elixir-lang/ex_doc/actions?query=workflow%3A%22CI%22) [![Coverage Status](https://coveralls.io/repos/github/elixir-lang/ex_doc/badge.svg?branch=master)](https://coveralls.io/github/elixir-lang/ex_doc?branch=master) ExDoc is a tool to generate documentation for your Elixir projects. To see an example, [you can access Elixir's official docs](https://hexdocs.pm/elixir/). To learn about how to document your projects, see [Elixir's writing documentation page](https://hexdocs.pm/elixir/writing-documentation.html). To see all supported options, see the documentation for [mix docs](https://hexdocs.pm/ex_doc/Mix.Tasks.Docs.html). ## Features ExDoc ships with many features: * Automatically generates HTML and EPUB documents from your API documentation * Support for custom pages and guides (in addition to the API reference) * Support for custom grouping of modules, functions, and pages in the sidebar * Generates HTML documentation accessible online and offline * Responsive design with built-in layout for phones and tablets * Customizable logo on the generated documentation * Each documented entry contains a direct link back to the source code * Full-text search * Keyboard shortcuts (press `?` inside an existing documentation to bring the help dialog) * Quick search with autocompletion support (`s` keyboard shortcut) * Go-to shortcut to take to any HexDocs package documentation with autocomplete support (`g` keyboard shortcut) * Support for night-mode (automatically detected according to the browser preferences) * Show tooltips when mousing over a link to a module/function (works for the current project and across projects) * A version dropdown to quickly switch to other versions (automatically configured when hosted on HexDocs) ## Using ExDoc with Mix To use ExDoc in your Mix projects, first add ExDoc as a dependency. If you are using Elixir v1.10, or later: ```elixir def deps do [ {:ex_doc, "~> 0.24", only: :dev, runtime: false}, ] end ``` If you are using Elixir v1.7, v1.8, or v1.9: ```elixir def deps do [ {:ex_doc, "~> 0.22.0", only: :dev, runtime: false}, ] end ``` If you are using Elixir v1.6, or earlier: ```elixir def deps do [ {:ex_doc, "~> 0.18.0", only: :dev, runtime: false}, ] end ``` After adding ExDoc as a dependency, run `mix deps.get` to install it. ExDoc will automatically pull in information from your projects, like the application and version. However, you may want to set `:name`, `:source_url` and `:homepage_url` to have a nicer output from ExDoc, such as: ```elixir def project do [ app: :my_app, version: "0.1.0-dev", deps: deps(), # Docs name: "MyApp", source_url: "https://github.com/USER/PROJECT", homepage_url: "http://YOUR_PROJECT_HOMEPAGE", docs: [ main: "MyApp", # The main page in the docs logo: "path/to/logo.png", extras: ["README.md"] ] ] end ``` Now you are ready to generate your project documentation with `mix docs`. To see all options available when generating docs, run `mix help docs`. ## Using ExDoc via command line You can ExDoc via the command line as follows: 1. Install ExDoc as an escript: ```bash $ mix escript.install hex ex_doc ``` 2. Then you are ready to use it in your projects. First, move into your project directory and make sure it is already compiled: ```bash $ cd PATH_TO_YOUR_PROJECT $ mix compile ``` 3. Next invoke the ex_doc executable from your project: ```bash $ ex_doc "PROJECT_NAME" "PROJECT_VERSION" path/to/project/ebin -m "PROJECT_MODULE" -u "https://github.com/GITHUB_USER/GITHUB_REPO" -l path/to/logo.png ``` For example, here are some acceptable values: PROJECT_NAME => Ecto PROJECT_VERSION => 0.1.0 PROJECT_MODULE => Ecto (the main module provided by the library) GITHUB_USER => elixir-lang GITHUB_REPO => ecto ## Auto-linking ExDoc will automatically generate links across modules and functions if you enclose them in backticks: * By referring to a module, function, type or callback from your project, such as `` `MyModule` ``, ExDoc will automatically link to those * By referring to a module, function, type or callback from Elixir, such as `` `String` ``, ExDoc will automatically link to Elixir's stable documentation * By referring to a function, type, or callback from OTP, such as (`` `:queue.new/0` ``), ExDoc will automatically link to the OTP documentation * By referring to a module, function, type or callback from any of your dependencies, such as `` `MyDep` ``, ExDoc will automatically link to that dependency documentation on [hexdocs.pm](https://hexdocs.pm/) (the link can be configured by setting `docs: [deps: [my_dep: "https://path/to/docs/"]]` in your `mix.exs`) ExDoc supports linking to modules (`` `MyModule` ``), functions (`` `MyModule.function/1` ``), types (`` `t:MyModule.type/2` ``) and callbacks (`` `c:MyModule.callback/3` ``). If you want to link a function, type or callback in the current module, you may skip the module name, such as `` `function/1` ``. You can also use a custom text, e.g.: `` [custom text](`MyModule.function/1`) ``. This also allows to refer to OTP modules, e.g.: `` [`:array`](`:array`) ``. Link to extra pages like this: `` [Up and running](Up and running.md) `` (skipping the directory the page is in), the final link will be automatically converted to `up-and-running.html`. ## Contributing The easiest way to test changes to ExDoc is to locally rebuild the app and its own documentation: 1. Run `mix setup` to install all dependencies 2. Run `mix build` to generate docs. This is a custom alias that will build assets, recompile ExDoc, and output fresh docs into the `doc/` directory 3. If you want to contribute a pull request, please do not add to your commits the files generated in the `assets/` and `formatters/` folders 4. Run `mix lint.` to check if the Elixir and JavaScript files are properly formatted. You can run `mix fix` to let the JavaScript linter and Elixir formatter fix the code automatically before submitting your pull request ## License ExDoc source code is released under [Apache 2 License](LICENSE). The generated contents, however, are under different licenses based on projects used to help render HTML, including CSS, JS, and other assets. Any documentation generated by ExDoc, or any documentation generated by any "Derivative Works" (as specified in the Apache 2 License), must include a direct, readable, and visible link to the [ExDoc repository](https://github.com/elixir-lang/ex_doc) on each rendered material. For HTML pages, a rendered material represents every single page. For PDF, EPUB and other ebook formats, it means one entry for the whole material.
评论
    相关推荐
    • HTML
      HTML HTML存储库。 HTML的嵌套库。
    • HTML教程
      HTML教程HTML教程HTML教程
    • HTMLHTML
      HTMLHTML
    • html
      html 佩拉蒂罕(Pelatihan)传播HTML和CSS
    • html相关
      html相关html相关html相关
    • Html教程
      Html教程 Html教程 Html教程 Html教程
    • html教程
      HTML教程关于基本语法的使用
    • html指南
      html查询指南,html格式
    • html
      html html 2021.03.22 HTML在Codecademy(chapter1)中的课程身体,头部,h,p,img,视频,标题,跨度,强壮,em 2021.03.23 HTML在Codecademy中学习课程(第2章)!DOCTYPE htmlhtml,table,thead,tbody ...
    • html学习
      html入门学习,适合初学者