文档和单页文档
良好的文档对于任何软件框架都很重要。它也以计数呈现的格式,尤其是当您只需要基于关键字即可快速找到某些内容时,甚至只是部分关键字或“直觉”或“直觉”时。通常,这就是搜索引擎的目的,但是除了被逐项列出并分解成较小的部分外,还可以通过将所有文档放入单个网页中来更容易。
。换句话说,除了“可点击”之外,还有“ ctrl-f”文档也很不错。它还包括示例和当前文章。
在线的
Vely现在有了这样的手册,并且可以使用online here。
可下载
您也可以将其下载为.tar.gz file。此可下载的文档已在允许的Creative Commons BY 4.0下许可,即使在商业环境中也可以共享,例如,您可以在商业产品中包含Vely文档,也可以将其包括在商业产品中或开源。一。
Vely开源许可证
请注意,Vely本身最近是在更宽松,更友好的Eclipse Public v2.0开源许可下重新许可的。
下载它
您可以下载Vely文档并将其托管在其他地方。这是有关如何做到这一点的简短教程。首先,获取单页文档:
wget -qO - https://vely.dev/velydoc.tar.gz > velydoc.tar.gz
然后,解开它。 “ -m”选项用于抑制有关不同系统上可能不同时间的任何警告:
tar xvfzm velydoc.tar.gz
这将把文档解压缩到“ VelyDoc”目录中。假设您的Web服务器的root文档目录为“/var/www/html”(如果不同的话,请在下面更改):
sudo mv velydoc /var/www/html/
最后,更改权限,以便您的Web服务器可以访问这些文件。假设您的Web服务器的操作系统组为“ www -data”(如果不同的话,则可以通过使用“ PS -EF”命令并在运行过程列表中查找您的Web服务器):
sudo chown -R www-data:www-data /var/www/html/velydoc/
现在,您应该能够访问文档页面(如果不在计算机上,则更改“ 127.0.0.1”,并将其替换为服务器的网址):
http://127.0.0.1/velydoc/velydoc.html
就是这样!快乐的Velying!
图像版权(c)Sergio Mijatovic 2023
本文根据CC-BY-4.0许可,该文章允许在商业上复制和重新分配 - 有关更多详细信息,请参见许可。