在线时间:8:00-16:00
迪恩网络APP
随时随地掌握行业动态
扫描二维码
关注迪恩网络微信公众号
开源软件名称(OpenSource Name):loopbackio/loopback.io开源软件地址(OpenSource Url):https://github.com/loopbackio/loopback.io开源编程语言(OpenSource Language):HTML 95.7%开源软件介绍(OpenSource Introduction):loopback.ioLoopBack community site, http://loopback.io. This website now includes the LoopBack documentation. NOTE: The website is served from the This repository is provided under the MIT License. SetupTo preview the website locally:
Bundler will look in the Gemfile for which gems to install. The Run and view site locallyRun Jekyll using the following command:
Then, load http://localhost:4001/ on your browser. NOTE: The docs part will be at http://localhost:4001/doc. It's not yet linked from the main "overview" part of the site, but will be once we launch (RSN). FormattingJekyll uses a variant of Markdown known as Kramdown. Jekyll uses the Liquid template engine for templating. Incorporating external READMEsThe documentation incorporates README files from a number of LoopBack example repositories. We use the get-readmes utility to fetch the README files directly from GitHub. Here is how to update the READMEs
From there, the README markdown files are incorporated into documentation articles using the standard Jekyll "include" syntax as follows (for example):
Incorporating updates from loopback-nextWe use a node script Linting ReadmesThere is an additional You can run this script thus: $ npm run lint-readmes LoopBack.io Docs SearchDocs Search is powered by IBM Watson Discovery. How it worksThere are two parts of work to get this working:
Front EndEach documentation page has a search bar the top. The search will redirect the
user to a Cloud FunctionThe code for the Cloud function can be found here. It is deployed to the same account and must be edited directly in IBM Cloud (formerly BlueMix). The repository exists to document code changes and have peer reviews. Credentials for accessing the Cloud Function can be obtained from Diana Lau OR you can ask them to re-deploy changes. Your own versionYou can deploy the code on your own IBM Cloud account and upload the URL for Discovery in search.html. ContributingThis project uses DCO. Be sure to sign off
your commits using the Example
Also see the Contributing to LoopBack documentation to get you started. |
2023-10-27
2022-08-15
2022-08-17
2022-09-23
2022-08-13
请发表评论