asoul-sig / asouldocs Goto Github PK

• Update logo
• Change license to MIT
• Update docs
• Resolve asoualdocs.dev and redirect peachdocs.org to it

试了很多次还是不行。
github的hook可以使用，但是gitlab的hook却不能使用。
我看是支持所有git的，请问这个是什么原因呢？

I'd love to see AsciiDoc support in peach.

Markdown is fine for simple use-cases documentation. AsciiDoc is far more richer than Markdown and is a necessity in serious documentation work.

AsciiDoc also has high quality tools for producing a wide range of output formats: html5, xhtml, docbook, pdf, epub, dvi, latex, roff, ps.
Peach can then provide a "export as pdf" kind of feature !

(hint: in the absence of plain go library that supports asciidoc, external ruby/python helpers can be used as done in case of hugo - gohugoio/hugo#470)

As Peach is based on Macaron and xyproto/permissions2 has support to Macaron, would it be possible to have a Permission manager into Peach ? Maybe under the form of a new Extension that user can enable or disable...

I think I will give this a shot in the coming months, maybe we can do it together ?

Hi @unknwon,

it would be useful to have a next and previous button at the bottom of each page in the documentation. This way users don't need to scroll back to the top on longer pages and look for the next page in the sidebar.

我用你的peach构建了一个网页，然后用微信浏览器打开有bug，显示的是你自己的东西，gitclone.com 您打开这个网址开一下，配置都没有生效

In reference to issue #3 of peach's doc.

Hi:
I got an error when install using go get

go get github.com/peachdocs/peach                                                         
# github.com/peachdocs/peach/modules/setting
../../../go/src/github.com/peachdocs/peach/modules/setting/setting.go:138: sec.Key("DOCS_BASE_URL").Validate undefined (type *ini.Key has no field or method Validate)

Is there out of the box support for HTTPS?

Sorry. I could not find this anywhere. Thanks

https://github.com/sourcegraph/docsite/tree/master/internal/search

it is useful to run peachdocs by docker image with docs dir mount

like this or something like this

docker pull peachdocs:latest
docker run -v ./opt/my.peach:/opt/peachdoc  peachdocs:latest --name=my-docs-container

thats why we need Dockerfile example (may be) or offical image for peachdoc

我的文档用户大多在国内，disqus很多人没有账号，可以把多说集成进来吗？

• 文档站点：http://bladejava.com
• 配置：https://github.com/bladejava/blade.peach
• 文档：https://github.com/bladejava/docs

主页，第一页在哪里显示的？ 一直没有看到怎么更换。

即点击首页显示的内容

官网qq用户群好像有问题呀

I have setup peachdocs on my remote server and everything is running excellent with a GitHub repo. Push updated documentation up to the GitHub repo, webhook triggers, updates my peachdocs instance on my remote web server.

I have been playing around with other git services besides GitHub. More specifically, GitLab.

I need my git remote server to be hosted privately. Password protecting peachdocs is great but I also need my git remote server repo to be hosted privately as well. For this purpose, I have been using GitLab for my private repo hosting.

I take my peachdocs website that is working 100% with GitHub, I change my remote git server from github to gitlab in the custom/app.ini file, I create my GitLab repo (create it public first just to try it out then I'll switch to private repo with deploy hook), create a webhook, remove my data/docs directory, then run peachdocs.

I push my code up to GitLab, the webhook runs successfully and in my peachdocs logs I see that the webhook is "completed successfully" just like it does with GitHub. Everything is working exactly the same as GitHub.

However, when I refresh my browser, I don't see any documentation. Peachdocs does not pull down the GitLab project and display it to me.

Does peachdocs work with any other git repo service besides GitHub? I was looking at the source but didn't find anything specific to GitHub.

VERSIONS:

$ docker --version
Docker version 1.11.2, build b9f10c9
$ docker exec peach /app/peach/peach --version
Peach version 0.9.2.1214

I'm following the docker instructions at:
https://github.com/peachdocs/peach/tree/master/docker

But when I run the following command it hangs and never start:

$ docker run --name=peach -p 5555:5555 -v peach-data:/data/peach peachdocs/peach
Jun 20 14:34:08 syslogd started: BusyBox v1.24.1

Some aditional info:

$ docker exec peach ps
PID   USER     TIME   COMMAND
    1 root       0:00 /bin/s6-svscan /app/peach/docker/s6/
   15 root       0:00 s6-supervise syslogd
   16 root       0:00 /sbin/syslogd -nS -O-
   20 root       0:00 ps

$ docker exec -it peach netstat -an
Active Internet connections (servers and established)
Proto Recv-Q Send-Q Local Address           Foreign Address         State
Active UNIX domain sockets (servers and established)
Proto RefCnt Flags       Type       State         I-Node Path
unix  2      [ ]         DGRAM                    29186355 /dev/log

$ docker logs peach
Jun 20 14:35:28 syslogd started: BusyBox v1.24.1

我视图写一个列表带链接

+ [简介](#简介)
+ [配置](#配置)
+ [配置方式](#配置方式)

生成的网页结果是这样的：

<ul>
<li><a href="#简介">简介</a></li>
<li><a href="#配置">配置</a></li>
<li><a href="#配置方式">配置方式</a></li>
<li><a href="#默认配置">默认配置</a></li>
</ul>

<div class="anchor-wrap" id="%E9%BB%98%E8%AE%A4%E9%85%8D%E7%BD%AE">
    <h1>默认配置
      <a href="#%E9%BB%98%E8%AE%A4%E9%85%8D%E7%BD%AE" class="anchor">
      <span class="octicon octicon-link"></span>
     </a>
    </h1>
</div>

在浏览器的URL上：

http://xx/docs/modules/config#%E9%85%8D%E7%BD%AE%E6%96%B9%E5%BC%8F

并不能访问到这个链接，有什么解决办法吗？

下载的时候出现了这个问题，请问怎么解决，GO1.13版本

verifying github.com/russross/[email protected]+incompatible/go.mod: github.com
/russross/[email protected]+incompatible/go.mod: reading https://goproxy.cn/sum
db/sum.golang.org/lookup/github.com/russross/[email protected]+incompatible: 40
4 Not Found

in some cases i will need to set custom page and custom template

for example:

i need to add addintional link "news" to navbar in app.ini, and then i want to have news.html template, in which i would create news feed from blog, social streems and others

localhost:5556/docs 访问的是缺省的文档仓库，是第0个仓库。不知是否支持多个文档仓库，如下列用法：
localhost:5556/docs1 访问第1个仓库，localhost:5556/docs2 访问第2个仓库。这样使用可适应多主题的大型文档。

I'm linking a documentation repository stored on a gogs server to peachdocs and
I want to connect to the instance using ssh.

Currently the docker image does not include the ssh client:

[Peach] 18-07-21 16:44:33 [FATAL] Fail to init docs:
Fail to update docs from remote source(git@gogs-server:rhalff/docs.git):
exit status 1 - error: cannot run ssh: No such file or directory

fatal: unable to fork

If docker installs the openssh-client package this issue will be gone.

https://github.com/peachdocs/peach/blob/master/Dockerfile#L7

Hi,

Is it possible to have a TOC depth greater than one on TOC.INI file ? I mean something like "/en_EN/dir1/subdir1/subdir2/doc.md".

It could be useful when a single project expose multiple API (ie: Public, B2B and Server-to-Server).

Thank you

就像gogs可以设置必须登录才允许访问内部一样。peach现有的保护内部资源不足以完成这个任务。

Describe the feature

Display the last updated time for the page.

Describe the solution you'd like

The time is displayed in RFC3339 format:

• For a local directory target, use the last modified time of the file.
• For a Git repository target, use the last changed time in Git history.

The frontmatter should also be able to allow user-defined last_updated_at.

Describe alternatives you've considered

n/a

Additional context

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

如题，谢谢。

// custom/app.ini的配置
[docs]
TYPE = local
TARGET = mydocs

然后mydocs和custom是同级目录

I'm curious as to whether its possible to have multiple documentation sets per install?

Like, could I have docs.example.com/project1/ and docs.example.com/project2/ where each project is loaded from a separate repo?

Sorry if its in the docs, I've read over it a few times but can't seem to find anything.

See https://github.com/yuin/goldmark/

我用archlinux 在本地试了一下，配置文件里面改了一下URL ，然后打开的时候js css都加载不出来，是我理解错了吗

I am looking up and down the code, but i can't seem to find where the default navbar is defined, when nothing is specified in app.ini

Hi, 无闻。

我目前有一个 repo, 配置了 peach, 但我不想分开文档跟源码。所以希望能设置目录切换。

目录如下：

└── foo
    ├── docs
    ├── README.md

改进后的配置：

[docs]
TYPE = remote
TARGET = https://github.com/johndoe/foo.git
TARGET_DIR = docs

例如导出成PDF, Single HTML, etc

如果在我的doc中有版本需要回滚，那么通过hook调用git pull 会不会出现问题！？

Hi,

I was fiddling around with peach a bit and tried to change DOCS_BASE_URL to "wiki" as well as "/wiki".
peach starts up fine, but you end up getting a 404 for every request, no matter whether the request goes to http://localhost/docs or http://localhost/wiki.

文件生成目录的话，应该怎么办？

Hi,

When I use

$ docker run --name=peach -p 5555:5555 -v /docker/peach/data:/data/peach peachdocs/peach

to start docker, log says

[Peach] 18-07-27 02:18:49 [FATAL] No custom configuration found: 'custom/app.ini'

and it can't start

trid to mkdir custom and add app.ini and mkdir locale and add EN CN file,
but it seems that the locale folder is not in the correct folder
log says can't find local -

in the document says

# Peach will complain about missing custom app.ini, leave it there and see Settings section below.

but the Settings section is empty.

Where can I find some information ?

Thank you.

Semantic-UI 使用了 google 字体，导致国内访问很慢

@import url(https://fonts.googleapis.com/css?family=Lato:400,700,400italic,700italic&subset=latin);

建议替换为本地字体

https://google-webfonts-helper.herokuapp.com/fonts/lato?subsets=latin

我们团队正在使用gogs，一些项目以及md文档都在上面。但开启了REQUIRE_SIGNIN_VIEW，需要登录才能访问。
在peach设置远程git地址时，感觉没用了啊。。。
这个看看能不能有什么方法进行配置，以打通gogs

• https://github.com/kyokomi/emoji
• https://github.com/enescakir/emoji

Currently it seems as though "0.0.0.0" is hardcoded without a way to change it.

I would like to request a config item in app.ini to be able to set the listening address to a specific IP.

Use case could be a Server with several network interfaces / ip addresses in different networks and wanting peach to only be served on one of them.

Another use case (my actual use case) would be to use a webserver like apache or nginx with reverse proxy. In this case we need to only listen on localhost.

您好，我想要自定义底部的文字，也是需要多语言的，像这样的：{{Tr(Lang, "footer.about")}}。但是查看代码后并没有找到定义多语言变量的地方，烦请告诉我如何定义多语言变量，感谢~

https://www.redclayinteractive.com/what-are-open-graph-tags/

我暂时没有英文支持，把复制过来的en-US文件夹删除掉，在配置中没有写到多语言的配置
启动报错

[Peach] 15-10-19 18:16:06 [ERROR] Fail to load doc file: open D:\Go\src\github.com\biezhi\blade.peach\docs/en-US/intro/README.md: The system cannot find the path specified.

强烈建议支持LDAP，域账户

in windows7 x64 or window10 x64， 从 release 下载的二进制版本。
https://github.com/peachdocs/peach/releases
所有都设置好了。

可是点击文件菜单，却无法显示。md的内容，可能是什么原因？

设置如下:
app.ini

RUN_MODE = dev
HTTP_PORT = 80

[site]
URL = http://localhost

[page]
USE_CUSTOM_TPL = true

[docs]
TYPE = local
TARGET = ./docs

我想看看文档呢，对go不是很熟，好像是一个搭建web文档的东西.
不知道怎么使用

对部分资源进行保护，指定用户访问。其他资源开放。
比如：增加一个security.ini配置，类似TOC.ini

[user]
username=passwd
xxx=xxxxxx

[auth]
/URL/PATH=username,username2
/URL/PATH2=username,username2