mirror of https://github.com/alibaba/arthas.git
new arthas doc by vuepress
hengyunabc
3 years ago
parent
ecc11d5bd6
commit
87025f4bfb
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@ -1,232 +0,0 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE 8]><html class="no-js lt-ie9" lang="zh-CN" > <![endif]-->
|
||||
<!--[if gt IE 8]><!--> <html class="no-js" lang="zh-CN" > <!--<![endif]-->
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title><no title> — Arthas 3.0.1-RC-SNAPSHOT 文档</title>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/overrides.css" type="text/css" />
|
||||
<link rel="index" title="索引" href="genindex.html" />
|
||||
<link rel="search" title="搜索" href="search.html" />
|
||||
<script src="_static/center_page.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search">
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Arthas
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="version">
|
||||
3.0.1-RC-SNAPSHOT
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-detail.html">安装</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="quick-start.html">快速入门</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="advanced-use.html">进阶使用</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="commands.html">命令列表</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/labels/user-case">用户案例</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="release-notes.html">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/labels/question-answered">Questions and answers</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas">Fork me at GitHub</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/CONTRIBUTING.md">参与贡献</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">Arthas</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html">Docs</a> »</li>
|
||||
|
||||
<li><no title></li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
|
||||
<a href="https://github.com/alibaba/arthas/blob/master/site/src/site/sphinx/README_EN.md" class="fa fa-github"> Edit on GitHub</a>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<p>This is home.</p>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018, Alibaba Middleware Group, and contributors.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'./',
|
||||
VERSION:'3.0.1-RC-SNAPSHOT',
|
||||
LANGUAGE:'zh_CN',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt'
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="_static/translations.js"></script>
|
||||
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
<div class="github-fork-ribbon-wrapper right">
|
||||
<div class="github-fork-ribbon">
|
||||
<a href="https://github.com/alibaba/arthas">Fork me at GitHub</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="_static/add_badges.js"></script>
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -1,263 +0,0 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE 8]><html class="no-js lt-ie9" lang="zh-CN" > <![endif]-->
|
||||
<!--[if gt IE 8]><!--> <html class="no-js" lang="zh-CN" > <!--<![endif]-->
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title><no title> — Arthas 3.0.1-RC-SNAPSHOT 文档</title>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/overrides.css" type="text/css" />
|
||||
<link rel="index" title="索引" href="genindex.html" />
|
||||
<link rel="search" title="搜索" href="search.html" />
|
||||
<script src="_static/center_page.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
<script src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search">
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Arthas
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="version">
|
||||
3.0.1-RC-SNAPSHOT
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-detail.html">安装</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="quick-start.html">快速入门</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="advanced-use.html">进阶使用</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="commands.html">命令列表</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/labels/user-case">用户案例</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="release-notes.html">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/labels/question-answered">Questions and answers</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas">Fork me at GitHub</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/CONTRIBUTING.md">参与贡献</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">Arthas</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html">Docs</a> »</li>
|
||||
|
||||
<li><no title></li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
|
||||
<a href="https://github.com/alibaba/arthas/blob/master/site/src/site/sphinx/SUMMARY.md" class="fa fa-github"> Edit on GitHub</a>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<ul>
|
||||
<li><p class="first">命令使用</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/tree/master/site/src/site/sphinx/dashboard">系统指标</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/tree/master/site/src/site/sphinx/thread">线程堆栈</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/tree/master/site/src/site/sphinx/jvm">JVM信息</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/tree/master/site/src/site/sphinx/sc">查看类信息</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/tree/master/site/src/site/sphinx/sm">查看方法信息</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/tree/master/site/src/site/sphinx/dump">dump字节码</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/tree/master/site/src/site/sphinx/jad">反编译类</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/tree/master/site/src/site/sphinx/classloader">查看类加载信息</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/tree/master/site/src/site/sphinx/monitor">方法执行监控</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/tree/master/site/src/site/sphinx/watch">方法AOP观测</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/tree/master/site/src/site/sphinx/trace">方法内部路径耗时</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/tree/master/site/src/site/sphinx/stack">查看方法调用栈</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/tree/master/site/src/site/sphinx/tt">方法执行记录与回放</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</li>
|
||||
<li><p class="first"><a class="reference external" href="https://github.com/alibaba/arthas/tree/master/site/src/site/sphinx/start-arthas">启动脚本说明</a></p>
|
||||
</li>
|
||||
<li><p class="first"><a class="reference external" href="https://github.com/alibaba/arthas/tree/master/site/src/site/sphinx/release-notes">Release Notes</a></p>
|
||||
</li>
|
||||
<li><p class="first">常见问题</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/tree/master/site/src/site/sphinx/TODO">FAQ</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018, Alibaba Middleware Group, and contributors.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'./',
|
||||
VERSION:'3.0.1-RC-SNAPSHOT',
|
||||
LANGUAGE:'zh_CN',
|
||||
COLLAPSE_INDEX:false,
|
||||
FILE_SUFFIX:'.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt'
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="_static/translations.js"></script>
|
||||
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
<div class="github-fork-ribbon-wrapper right">
|
||||
<div class="github-fork-ribbon">
|
||||
<a href="https://github.com/alibaba/arthas">Fork me at GitHub</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript" src="_static/add_badges.js"></script>
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -1 +0,0 @@
|
||||
This is home.
|
||||
@ -1,18 +0,0 @@
|
||||
* 命令使用
|
||||
* [系统指标](dashboard)
|
||||
* [线程堆栈](thread)
|
||||
* [JVM信息](jvm)
|
||||
* [查看类信息](sc)
|
||||
* [查看方法信息](sm)
|
||||
* [dump字节码](dump)
|
||||
* [反编译类](jad)
|
||||
* [查看类加载信息](classloader)
|
||||
* [方法执行监控](monitor)
|
||||
* [方法AOP观测](watch)
|
||||
* [方法内部路径耗时](trace)
|
||||
* [查看方法调用栈](stack)
|
||||
* [方法执行记录与回放](tt)
|
||||
* [启动脚本说明](start-arthas)
|
||||
* [Release Notes](release-notes)
|
||||
* 常见问题
|
||||
* [FAQ](TODO)
|
||||
@ -1,245 +0,0 @@
|
||||
AutoStructify Component
|
||||
=======================
|
||||
AutoStructify is a component in recommonmark that takes a parsed docutil AST by `CommonMarkParser`,
|
||||
and transform it to another AST that introduces some of more. This enables additional features
|
||||
of recommonmark syntax, to introduce more structure into the final generated document.
|
||||
|
||||
|
||||
Configuring AutoStructify
|
||||
-------------------------
|
||||
The behavior of AutoStructify can be configured via a dict in document setting.
|
||||
In sphinx, you can configure it by `conf.py`. The following snippet
|
||||
is what is actually used to generate this document, see full code at [conf.py](conf.py).
|
||||
|
||||
```python
|
||||
github_doc_root = 'https://github.com/rtfd/recommonmark/tree/master/doc/'
|
||||
def setup(app):
|
||||
app.add_config_value('recommonmark_config', {
|
||||
'url_resolver': lambda url: github_doc_root + url,
|
||||
'auto_toc_tree_section': 'Contents',
|
||||
}, True)
|
||||
app.add_transform(AutoStructify)
|
||||
|
||||
```
|
||||
All the features are by default enabled
|
||||
|
||||
***List of options***
|
||||
* __enable_auto_toc_tree__: whether enable [Auto Toc Tree](#auto-toc-tree) feature.
|
||||
* __auto_toc_tree_section__: when enabled, [Auto Toc Tree](#auto-toc-tree) will only be enabled on section that matches the title.
|
||||
* __enable_auto_doc_ref__: whether enable [Auto Doc Ref](#auto-doc-ref) feature. **Deprecated**
|
||||
* __enable_math__: whether enable [Math Formula](#math-formula)
|
||||
* __enable_inline_math__: whether enable [Inline Math](#inline-math)
|
||||
* __enable_eval_rst__: whether [Embed reStructuredText](#embed-restructuredtext) is enabled.
|
||||
* __url_resolver__: a function that maps a existing relative position in the document to a http link
|
||||
|
||||
Auto Toc Tree
|
||||
-------------
|
||||
One of important command in tools like sphinx is `toctree`. This is a command to generate table of contents and
|
||||
tell sphinx about the structure of the documents. In markdown, usually we manually list of contents by a bullet list
|
||||
of url reference to the other documents.
|
||||
|
||||
AutoStructify will transforms bullet list of document URLs
|
||||
|
||||
```
|
||||
* [Title1](doc1.md)
|
||||
* [Title2](doc2.md)
|
||||
```
|
||||
will be translated to the AST of following reStructuredText code
|
||||
```rst
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
doc1
|
||||
doc2
|
||||
```
|
||||
You can also find the usage of this feature in `index.md` of this document.
|
||||
|
||||
Auto Doc Ref
|
||||
------------
|
||||
|
||||
```eval_rst
|
||||
.. note:: **This option is deprecated.**
|
||||
This option has been superseded by the default linking behavior, which
|
||||
will first try to resolve as an internal reference, and then as an
|
||||
external reference.
|
||||
```
|
||||
|
||||
It is common to refer to another document page in one document. We usually use reference to do that.
|
||||
AutoStructify will translate these reference block into a structured document reference. For example
|
||||
```
|
||||
[API Reference](api_ref.md)
|
||||
```
|
||||
will be translated to the AST of following reStructuredText code
|
||||
```
|
||||
:doc:`API Reference </api_ref>`
|
||||
```
|
||||
And it will be rendered as [API Reference](api_ref)
|
||||
|
||||
URL Resolver
|
||||
------------
|
||||
Sometimes in a markdown, we want to refer to the code in the same repo.
|
||||
This can usually be done by a reference by reference path. However, since the generated document is hosted elsewhere,
|
||||
the relative path may not work in generated document site. URL resolver is introduced to solve this problem.
|
||||
|
||||
Basically, you can define a function that maps an relative path of document to the http path that you wish to link to.
|
||||
For example, the setting mentioned in the beginning of this document used a resolver that maps the files to github.
|
||||
So `[parser code](../recommonmark/parser.py)` will be translated into [parser code](../recommonmark/parser.py)
|
||||
|
||||
Note that the reference to the internal document will not be passed to url resolver, and will be linked to the internal document pages correctly, see [Auto Doc Ref](#auto-doc-ref).
|
||||
|
||||
|
||||
Codeblock Extensions
|
||||
--------------------
|
||||
In markdown, you can write codeblocks fenced by (at least) three backticks
|
||||
(```` ``` ````). The following is an example of codeblock.
|
||||
|
||||
````
|
||||
``` language
|
||||
some code block
|
||||
```
|
||||
````
|
||||
|
||||
Codeblock extensions are mechanism that specialize certain codeblocks to different render behaviors.
|
||||
The extension will be trigger by the language argument to the codeblck
|
||||
|
||||
### Syntax Highlight
|
||||
You can highlight syntax of codeblocks by specifying the language you need. For example,
|
||||
|
||||
````
|
||||
```python
|
||||
def function():
|
||||
return True
|
||||
```
|
||||
````
|
||||
|
||||
will be rendered as
|
||||
|
||||
```python
|
||||
def function():
|
||||
return True
|
||||
```
|
||||
|
||||
### Math Formula
|
||||
You can normally write latex math formula with `math` codeblock. See also [Inline Math](#inline-math).
|
||||
|
||||
Example
|
||||
|
||||
````
|
||||
```math
|
||||
E = m c^2
|
||||
```
|
||||
````
|
||||
|
||||
will be rendered as
|
||||
|
||||
```math
|
||||
E = m c^2
|
||||
```
|
||||
|
||||
### Embed reStructuredText
|
||||
Recommonmark also allows embedding reStructuredText syntax in the codeblocks.
|
||||
There are two styles for embedding reStructuredText. The first is enabled by `eval_rst` codeblock. The content of codeblock will be parsed as reStructuredText and insert into the document. This can be used to quickly introduce some of reStructuredText command that not yet available in markdown. For example,
|
||||
|
||||
````
|
||||
```eval_rst
|
||||
.. autoclass:: recommonmark.transform.AutoStructify
|
||||
:show-inheritance:
|
||||
```
|
||||
````
|
||||
|
||||
will be rendered as
|
||||
|
||||
```eval_rst
|
||||
.. autoclass:: recommonmark.transform.AutoStructify
|
||||
:show-inheritance:
|
||||
```
|
||||
|
||||
This example used to use sphinx autodoc to insert document of AutoStructify class definition into the document.
|
||||
|
||||
The second style is a shorthand of the above style. It allows you to leave off the eval_rst .. portion and directly render directives. For example,
|
||||
|
||||
````rst
|
||||
``` important:: Its a note! in markdown!
|
||||
```
|
||||
````
|
||||
|
||||
will be rendered as
|
||||
|
||||
``` important:: Its a note! in markdown!
|
||||
```
|
||||
|
||||
#### An Advanced Example
|
||||
|
||||
````rst
|
||||
``` sidebar:: Line numbers and highlights
|
||||
|
||||
emphasis-lines:
|
||||
highlights the lines.
|
||||
linenos:
|
||||
shows the line numbers as well.
|
||||
caption:
|
||||
shown at the top of the code block.
|
||||
name:
|
||||
may be referenced with `:ref:` later.
|
||||
```
|
||||
|
||||
``` code-block:: markdown
|
||||
:linenos:
|
||||
:emphasize-lines: 3,5
|
||||
:caption: An example code-block with everything turned on.
|
||||
:name: Full code-block example
|
||||
|
||||
# Comment line
|
||||
import System
|
||||
System.run_emphasis_line
|
||||
# Long lines in code blocks create a auto horizontal scrollbar
|
||||
System.exit!
|
||||
```
|
||||
````
|
||||
|
||||
will be rendered as
|
||||
|
||||
``` sidebar:: Line numbers and highlights
|
||||
|
||||
emphasis-lines:
|
||||
highlights the lines.
|
||||
linenos:
|
||||
shows the line numbers as well.
|
||||
caption:
|
||||
shown at the top of the code block.
|
||||
name:
|
||||
may be referenced with `:ref:` later.
|
||||
```
|
||||
|
||||
``` code-block:: markdown
|
||||
:linenos:
|
||||
:emphasize-lines: 3,5
|
||||
:caption: An example code-block with everything turned on.
|
||||
:name: Full code-block example
|
||||
|
||||
# Comment line
|
||||
import System
|
||||
System.run_emphasis_line
|
||||
# Long lines in code blocks create a auto horizontal scrollbar
|
||||
System.exit!
|
||||
```
|
||||
|
||||
The `<div style="clear: right;"></div>` line clears the sidebar for the next title.
|
||||
|
||||
<div style="clear: right;"></div>
|
||||
|
||||
|
||||
Inline Math
|
||||
-----------
|
||||
Besides the [Math Formula](#math-formula), you can also write latex math in inline codeblock text. You can do so by inserting `$`
|
||||
in the beginning and end of inline codeblock.
|
||||
|
||||
Example
|
||||
|
||||
```
|
||||
This formula `$ y=\sum_{i=1}^n g(x_i) $`
|
||||
```
|
||||
|
||||
will be rendered as:
|
||||
|
||||
This formula `$ y=\sum_{i=1}^n g(x_i) $`
|
||||
@ -1,57 +0,0 @@
|
||||
命令列表
|
||||
=============
|
||||
|
||||
* [dashboard](dashboard.md)
|
||||
* [thread](thread.md)
|
||||
* [jvm](jvm.md)
|
||||
* [memory](memory.md)
|
||||
* [sysprop](sysprop.md)
|
||||
* [sysenv](sysenv.md)
|
||||
* [vmoption](vmoption.md)
|
||||
* [perfcounter](perfcounter.md)
|
||||
* [logger](logger.md)
|
||||
* [mbean](mbean.md)
|
||||
* [getstatic](getstatic.md)
|
||||
|
||||
* [ognl](ognl.md)
|
||||
|
||||
* [sc](sc.md)
|
||||
* [sm](sm.md)
|
||||
* [dump](dump.md)
|
||||
* [heapdump](heapdump.md)
|
||||
* [vmtool](vmtool.md)
|
||||
|
||||
* [jad](jad.md)
|
||||
* [classloader](classloader.md)
|
||||
* [mc](mc.md)
|
||||
* [retransform](retransform.md)
|
||||
* [redefine](redefine.md)
|
||||
|
||||
* [monitor](monitor.md)
|
||||
* [watch](watch.md)
|
||||
* [trace](trace.md)
|
||||
* [stack](stack.md)
|
||||
* [tt](tt.md)
|
||||
|
||||
* [profiler](profiler.md)
|
||||
|
||||
* [cat](cat.md)
|
||||
* [echo](echo.md)
|
||||
* [grep](grep.md)
|
||||
* [base64](base64.md)
|
||||
* [tee](tee.md)
|
||||
* [pwd](pwd.md)
|
||||
* [auth](auth.md)
|
||||
* [options](options.md)
|
||||
|
||||
### Arthas 基础命令
|
||||
|
||||
* [help](help.md)
|
||||
* [cls](cls.md)
|
||||
* [session](session.md)
|
||||
* [reset](reset.md)
|
||||
* [version](version.md)
|
||||
* [history](history.md)
|
||||
* [quit](quit.md)
|
||||
* [stop](stop.md)
|
||||
* [keymap](keymap.md)
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue