-
-
- #人生路途
- - -#人生路途
- - -其实环境搭建没什么难的，但是遇到一些问题，主要是有些网站资源访问不了(如：golang.org)， -导致一些包无法安装，最终会导致环境搭建失败，跟据这个教程几步，我们将可以快速的构建golang的开发环境。
-
这里我用需要安装一些工具：
- -2.Golang下载
-这里我使用的是Go1.6.
-3.git下载
-这一步跟建环境没什么关系，
-但是之后要引用一些包需要它.
-
安装方法:打开vscode 按F1 然后选择安装扩展 选择go 下载后 重启
-
vscode-go 插件需要一些工具，这些功具默认需要这样安装：
-
-go get -u -v github.com/nsf/gocode
-go get -u -v github.com/rogpeppe/godef
-go get -u -v github.com/golang/lint/golint
-go get -u -v github.com/lukehoban/go-outline
-go get -u -v sourcegraph.com/sqs/goreturns
-go get -u -v golang.org/x/tools/cmd/gorename
-go get -u -v github.com/tpng/gopkgs
-go get -u -v github.com/newhook/go-symbols
-go get -u -v golang.org/x/tools/cmd/guru
-(以及dlv调试运行工具)
-
-这些内容最终目的是要在gopath中bin文件夹中生成一些exe文件。
-但是，这里安装时遇到了一些问题，有一些会安装失败，报错信息主要意思是说无法链接啊，无法找到啊之类的。
-这里我省略这些步骤。直接下载我已经生成的exe包，放在gopath的bin文件夹中就行了。如下图：
-
1.GOPATH：这个是你的工作目录，请在系统新加一个GOPATH指定你的工作目录,并且在工作目录中新建 -bin,pkg,src三个文件夹。
-2.Git：将git安装目录下的bin目录加入Path环境变量。
-3.用vscode打开src文件夹添加两个文件如下：
-
{
- "files.autoSave": "onFocusChange",
- "go.buildOnSave": true,
- "go.lintOnSave": true,
- "go.vetOnSave": true,
- "go.buildTags": "",
- "go.buildFlags": [],
- "go.lintFlags": [],
- "go.vetFlags": [],
- "go.coverOnSave": false,
- "go.useCodeSnippetsOnFunctionSuggest": false,
- "go.formatOnSave": true,
- "go.formatTool": "goreturns",
- "go.goroot": "C:\\Go",
- "go.gopath": "H:\\Projects\\GitHub\\Go",
- "go.gocodeAutoBuild": true
-}
-
{
- "version": "0.2.0",
- "configurations": [
- {
- "name": "Launch",
- "type": "go",
- "request": "launch",
- "mode": "debug",
- "remotePath": "",
- "port": 2345,
- "host": "127.0.0.1",
- "program": "${workspaceRoot}\\helloworld",
- "env": {},
- "args": []
- }
- ]
-}
-##运行
-
-##调试
-
这些库因为不能获取，我在github上找了好久，最后编译成exe,国内找不到几篇文章提到这个问题， -所以写个博客，让大家方便的开发。希望大家快乐的学习go语言。
- -1、手机html5 App标准头
-<meta name="viewport" content="width=device-width,user-scalable=no">
-2、iPhone 手机上默认值是（电话号码显示为拨号的超链接）
-<meta name="format-detection" content="telephone=no"/>
-3、禁用右键CSS
-:root {
--webkit-touch-callout:none;
--webkit-user-select:none;
--khtml-user-select:none;
--moz-user-select:none;
--ms-user-select:none;
-user-select:none;
-}
-
-
-
-
--A Markdown parser written in Go. Easy to extend, standards-compliant, well-structured.
-
goldmark is compliant with CommonMark 0.31.2.
-I needed a Markdown parser for Go that satisfies the following requirements:
-golang-commonmark may be a good choice, but it seems to be a copy of markdown-it.
-blackfriday.v2 is a fast and widely-used implementation, but is not CommonMark-compliant and cannot be extended from outside of the package, since its AST uses structs instead of interfaces.
-Furthermore, its behavior differs from other implementations in some cases, especially regarding lists: Deep nested lists don't output correctly #329, List block cannot have a second line #244, etc.
-This behavior sometimes causes problems. If you migrate your Markdown text from GitHub to blackfriday-based wikis, many lists will immediately be broken.
-As mentioned above, CommonMark is complicated and hard to implement, so Markdown parsers based on CommonMark are few and far between.
-@username mention syntax to Markdown?
-You can easily do so in goldmark. You can add your AST nodes,
-parsers for block-level elements, parsers for inline-level elements,
-transformers for paragraphs, transformers for the whole AST structure, and
-renderers.go test --fuzz.1$ go get github.com/yuin/goldmark
-Import packages:
-1import (
-2 "bytes"
-3 "github.com/yuin/goldmark"
-4)
-Convert Markdown documents with the CommonMark-compliant mode:
-1var buf bytes.Buffer
-2if err := goldmark.Convert(source, &buf); err != nil {
-3 panic(err)
-4}
-1var buf bytes.Buffer
-2if err := goldmark.Convert(source, &buf, parser.WithContext(ctx)); err != nil {
-3 panic(err)
-4}
-| Functional option | -Type | -Description | -
|---|---|---|
parser.WithContext |
-A parser.Context |
-Context for the parsing phase. | -
| Functional option | -Type | -Description | -
|---|---|---|
parser.WithIDs |
-A parser.IDs |
-IDs allows you to change logics that are related to element id(ex: Auto heading id generation). |
-
1import (
- 2 "bytes"
- 3 "github.com/yuin/goldmark"
- 4 "github.com/yuin/goldmark/extension"
- 5 "github.com/yuin/goldmark/parser"
- 6 "github.com/yuin/goldmark/renderer/html"
- 7)
- 8
- 9md := goldmark.New(
-10 goldmark.WithExtensions(extension.GFM),
-11 goldmark.WithParserOptions(
-12 parser.WithAutoHeadingID(),
-13 ),
-14 goldmark.WithRendererOptions(
-15 html.WithHardWraps(),
-16 html.WithXHTML(),
-17 ),
-18 )
-19var buf bytes.Buffer
-20if err := md.Convert(source, &buf); err != nil {
-21 panic(err)
-22}
-| Functional option | -Type | -Description | -
|---|---|---|
goldmark.WithParser |
-parser.Parser |
-This option must be passed before goldmark.WithParserOptions and goldmark.WithExtensions |
-
goldmark.WithRenderer |
-renderer.Renderer |
-This option must be passed before goldmark.WithRendererOptions and goldmark.WithExtensions |
-
goldmark.WithParserOptions |
-...parser.Option |
-- |
goldmark.WithRendererOptions |
-...renderer.Option |
-- |
goldmark.WithExtensions |
-...goldmark.Extender |
-- |
| Functional option | -Type | -Description | -
|---|---|---|
parser.WithBlockParsers |
-A util.PrioritizedSlice whose elements are parser.BlockParser |
-Parsers for parsing block level elements. | -
parser.WithInlineParsers |
-A util.PrioritizedSlice whose elements are parser.InlineParser |
-Parsers for parsing inline level elements. | -
parser.WithParagraphTransformers |
-A util.PrioritizedSlice whose elements are parser.ParagraphTransformer |
-Transformers for transforming paragraph nodes. | -
parser.WithASTTransformers |
-A util.PrioritizedSlice whose elements are parser.ASTTransformer |
-Transformers for transforming an AST. | -
parser.WithAutoHeadingID |
-- |
-Enables auto heading ids. | -
parser.WithAttribute |
-- |
-Enables custom attributes. Currently only headings supports attributes. | -
| Functional option | -Type | -Description | -
|---|---|---|
html.WithWriter |
-html.Writer |
-html.Writer for writing contents to an io.Writer. |
-
html.WithHardWraps |
-- |
-Render newlines as <br>. |
-
html.WithXHTML |
-- |
-Render as XHTML. | -
html.WithUnsafe |
-- |
-By default, goldmark does not render raw HTML or potentially dangerous links. With this option, goldmark renders such content as written. | -
extension.Table
-
-extension.Strikethrough
-
-extension.Linkify
-
-extension.TaskList
-
-extension.GFM
-extension.DefinitionList
-
-extension.Footnote
-
-extension.Typographer
-extension.CJK
-The parser.WithAttribute option allows you to define attributes on some elements.
Currently only headings support attributes.
-Attributes are being discussed in the -CommonMark forum. -This syntax may possibly change in the future.
-## heading ## {#id .className attrName=attrValue class="class1 class2"}
-
-## heading {#id .className attrName=attrValue class="class1 class2"}
-heading {#id .className attrName=attrValue}
-============
-The Table extension implements Table(extension), as -defined in GitHub Flavored Markdown Spec.
-Specs are defined for XHTML, so specs use some deprecated attributes for HTML5.
-You can override alignment rendering method via options.
-| Functional option | -Type | -Description | -
|---|---|---|
extension.WithTableCellAlignMethod |
-extension.TableCellAlignMethod |
-Option indicates how are table cells aligned. | -
The Typographer extension translates plain ASCII punctuation characters into typographic-punctuation HTML entities.
-Default substitutions are:
-| Punctuation | -Default entity | -
|---|---|
' |
-‘, ’ |
-
" |
-“, ” |
-
-- |
-– |
-
--- |
-— |
-
... |
-… |
-
<< |
-« |
-
>> |
-» |
-
You can override the default substitutions via extensions.WithTypographicSubstitutions:
1markdown := goldmark.New(
- 2 goldmark.WithExtensions(
- 3 extension.NewTypographer(
- 4 extension.WithTypographicSubstitutions(extension.TypographicSubstitutions{
- 5 extension.LeftSingleQuote: []byte("‚"),
- 6 extension.RightSingleQuote: nil, // nil disables a substitution
- 7 }),
- 8 ),
- 9 ),
-10)
-The Linkify extension implements Autolinks(extension), as -defined in GitHub Flavored Markdown Spec.
-Since the spec does not define details about URLs, there are numerous ambiguous cases.
-You can override autolinking patterns via options.
-| Functional option | -Type | -Description | -
|---|---|---|
extension.WithLinkifyAllowedProtocols |
-[][]byte | []string |
-List of allowed protocols such as []string{ "http:" } |
-
extension.WithLinkifyURLRegexp |
-*regexp.Regexp |
-Regexp that defines URLs, including protocols | -
extension.WithLinkifyWWWRegexp |
-*regexp.Regexp |
-Regexp that defines URL starting with www.. This pattern corresponds to the extended www autolink |
-
extension.WithLinkifyEmailRegexp |
-*regexp.Regexp |
-Regexp that defines email addresses` | -
Example, using xurls:
- 1import "mvdan.cc/xurls/v2"
- 2
- 3markdown := goldmark.New(
- 4 goldmark.WithRendererOptions(
- 5 html.WithXHTML(),
- 6 html.WithUnsafe(),
- 7 ),
- 8 goldmark.WithExtensions(
- 9 extension.NewLinkify(
-10 extension.WithLinkifyAllowedProtocols([]string{
-11 "http:",
-12 "https:",
-13 }),
-14 extension.WithLinkifyURLRegexp(
-15 xurls.Strict,
-16 ),
-17 ),
-18 ),
-19)
-The Footnote extension implements PHP Markdown Extra: Footnotes.
-This extension has some options:
-| Functional option | -Type | -Description | -
|---|---|---|
extension.WithFootnoteIDPrefix |
-[]byte | string |
-a prefix for the id attributes. | -
extension.WithFootnoteIDPrefixFunction |
-func(gast.Node) []byte |
-a function that determines the id attribute for given Node. | -
extension.WithFootnoteLinkTitle |
-[]byte | string |
-an optional title attribute for footnote links. | -
extension.WithFootnoteBacklinkTitle |
-[]byte | string |
-an optional title attribute for footnote backlinks. | -
extension.WithFootnoteLinkClass |
-[]byte | string |
-a class for footnote links. This defaults to footnote-ref. |
-
extension.WithFootnoteBacklinkClass |
-[]byte | string |
-a class for footnote backlinks. This defaults to footnote-backref. |
-
extension.WithFootnoteBacklinkHTML |
-[]byte | string |
-a class for footnote backlinks. This defaults to ↩︎. |
-
Some options can have special substitutions. Occurrences of “^^” in the string will be replaced by the corresponding footnote number in the HTML output. Occurrences of “%%” will be replaced by a number for the reference (footnotes can have multiple references).
-extension.WithFootnoteIDPrefix and extension.WithFootnoteIDPrefixFunction are useful if you have multiple Markdown documents displayed inside one HTML document to avoid footnote ids to clash each other.
extension.WithFootnoteIDPrefix sets fixed id prefix, so you may write codes like the following:
1for _, path := range files {
- 2 source := readAll(path)
- 3 prefix := getPrefix(path)
- 4
- 5 markdown := goldmark.New(
- 6 goldmark.WithExtensions(
- 7 NewFootnote(
- 8 WithFootnoteIDPrefix(path),
- 9 ),
-10 ),
-11 )
-12 var b bytes.Buffer
-13 err := markdown.Convert(source, &b)
-14 if err != nil {
-15 t.Error(err.Error())
-16 }
-17}
-extension.WithFootnoteIDPrefixFunction determines an id prefix by calling given function, so you may write codes like the following:
1markdown := goldmark.New(
- 2 goldmark.WithExtensions(
- 3 NewFootnote(
- 4 WithFootnoteIDPrefixFunction(func(n gast.Node) []byte {
- 5 v, ok := n.OwnerDocument().Meta()["footnote-prefix"]
- 6 if ok {
- 7 return util.StringToReadOnlyBytes(v.(string))
- 8 }
- 9 return nil
-10 }),
-11 ),
-12 ),
-13)
-14
-15for _, path := range files {
-16 source := readAll(path)
-17 var b bytes.Buffer
-18
-19 doc := markdown.Parser().Parse(text.NewReader(source))
-20 doc.Meta()["footnote-prefix"] = getPrefix(path)
-21 err := markdown.Renderer().Render(&b, source, doc)
-22}
-You can use goldmark-meta to define a id prefix in the markdown document:
-1---
-2title: document title
-3slug: article1
-4footnote-prefix: article1
-5---
-6
-7# My article
-8
-CommonMark gives compatibilities a high priority and original markdown was designed by westerners. So CommonMark lacks considerations for languages like CJK.
-This extension provides additional options for CJK users.
-| Functional option | -Type | -Description | -
|---|---|---|
extension.WithEastAsianLineBreaks |
-...extension.EastAsianLineBreaksStyle |
-Soft line breaks are rendered as a newline. Some asian users will see it as an unnecessary space. With this option, soft line breaks between east asian wide characters will be ignored. This defaults to EastAsianLineBreaksStyleSimple. |
-
extension.WithEscapedSpace |
-- |
-Without spaces around an emphasis started with east asian punctuations, it is not interpreted as an emphasis(as defined in CommonMark spec). With this option, you can avoid this inconvenient behavior by putting 'not rendered' spaces around an emphasis like 太郎は\ **「こんにちわ」**\ といった. |
-
| Style | -Description | -
|---|---|
EastAsianLineBreaksStyleSimple |
-Soft line breaks are ignored if both sides of the break are east asian wide character. This behavior is the same as east_asian_line_breaks in Pandoc. |
-
EastAsianLineBreaksCSS3Draft |
-This option implements CSS text level3 Segment Break Transformation Rules with some enhancements. | -
EastAsianLineBreaksStyleSimpleInput Markdown:
-1私はプログラマーです。
-2東京の会社に勤めています。
-3GoでWebアプリケーションを開発しています。
-Output:
-1<p>私はプログラマーです。東京の会社に勤めています。\nGoでWebアプリケーションを開発しています。</p>
-EastAsianLineBreaksCSS3DraftInput Markdown:
-1私はプログラマーです。
-2東京の会社に勤めています。
-3GoでWebアプリケーションを開発しています。
-Output:
-1<p>私はプログラマーです。東京の会社に勤めています。GoでWebアプリケーションを開発しています。</p>
-By default, goldmark does not render raw HTML or potentially-dangerous URLs. -If you need to gain more control over untrusted contents, it is recommended that you -use an HTML sanitizer such as bluemonday.
-You can run this benchmark in the _benchmark directory.
blackfriday v2 seems to be the fastest, but as it is not CommonMark compliant, its performance cannot be directly compared to that of the CommonMark-compliant libraries.
-goldmark, meanwhile, builds a clean, extensible AST structure, achieves full compliance with -CommonMark, and consumes less memory, all while being reasonably fast.
-BenchmarkMarkdown/Blackfriday-v2-8 302 3743747 ns/op 3290445 B/op 20050 allocs/op
-BenchmarkMarkdown/GoldMark-8 280 4200974 ns/op 2559738 B/op 13435 allocs/op
-BenchmarkMarkdown/CommonMark-8 226 5283686 ns/op 2702490 B/op 20792 allocs/op
-BenchmarkMarkdown/Lute-8 12 92652857 ns/op 10602649 B/op 40555 allocs/op
-BenchmarkMarkdown/GoMarkdown-8 13 81380167 ns/op 2245002 B/op 22889 allocs/op
------------ cmark -----------
-file: _data.md
-iteration: 50
-average: 0.0044073057 sec
-------- goldmark -------
-file: _data.md
-iteration: 50
-average: 0.0041611990 sec
-As you can see, goldmark's performance is on par with cmark's.
-goldmark.WithRenderer().#hashtag-based tagging to goldmark.[[wiki]]-style links to goldmark.<figure> elements.goldmark.WithRenderer().goldmark-dynamic allows you to write a goldmark extension in Lua and load it at runtime without re-compilation.
-Please refer to goldmark-dynamic for details.
-goldmark's Markdown processing is outlined in the diagram below.
- <Markdown in []byte, parser.Context>
- |
- V
- +-------- parser.Parser ---------------------------
- | 1. Parse block elements into AST
- | 1. If a parsed block is a paragraph, apply
- | ast.ParagraphTransformer
- | 2. Traverse AST and parse blocks.
- | 1. Process delimiters(emphasis) at the end of
- | block parsing
- | 3. Apply parser.ASTTransformers to AST
- |
- V
- <ast.Node>
- |
- V
- +------- renderer.Renderer ------------------------
- | 1. Traverse AST and apply renderer.NodeRenderer
- | corespond to the node type
-
- |
- V
- <Output>
-Markdown documents are read through text.Reader interface.
AST nodes do not have concrete text. AST nodes have segment information of the documents, represented by text.Segment .
text.Segment has 3 attributes: Start, End, Padding .
(TBC)
-TODO
-See extension directory for examples of extensions.
Summary:
-ast.BaseBlock or ast.BaseInline is embedded.parser.BlockParser or parser.InlineParser.renderer.NodeRenderer.goldmark.Extender.BTC: 1NEDSyUmo4SMTDP83JJQSWi1MvQUGGNMZB
-MIT
-Yusuke Inuzuka
- -