[documentation (deploy)] deploy docsify in docker. #1241
Conversation
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/docsify-core/docsify-preview/gfuhxhs2l |
Koooooo-7
requested review from
anikethsaha,
jhildenbiddle,
sy-records and
trusktr
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 682330e:
|
docs/deploy.md
Outdated
|
|
||
| ## Docker | ||
|
|
||
| >There is a simple demo for building docsify in docker. |
There was a problem hiding this comment.
Can we remove this? I'm not sure why this is here (or why it's formatted using a blockquote)
There was a problem hiding this comment.
yep, it is unnecessary.
docs/deploy.md
Outdated
|
|
||
| >There is a simple demo for building docsify in docker. | ||
|
|
||
| ?> tips: you can create all the files for this demo from [Quickstart](https://docsify.js.org/#/quickstart?id=initialize). |
There was a problem hiding this comment.
The link to the Quickstart should be provided under the docsify bullet below, not above it. Otherwise, this tip implies "all of the files for this demo" including a docker file, which the Quickstart section does not discuss. Recommend removing this and just adding a link (not a tip) under the docsify bullet below.
docs/deploy.md
Outdated
|
|
||
| ?> tips: you can create all the files for this demo from [Quickstart](https://docsify.js.org/#/quickstart?id=initialize). | ||
|
|
||
| - Preparing Docsify initial files |
There was a problem hiding this comment.
Making bullet names consistent: "Create docsify files"
docs/deploy.md
Outdated
| ?> tips: you can create all the files for this demo from [Quickstart](https://docsify.js.org/#/quickstart?id=initialize). | ||
|
|
||
| - Preparing Docsify initial files | ||
| You need prepare the initial files (generated by run `docsify init ./docs`) instead of making in container. |
There was a problem hiding this comment.
To prevent outdated instructions here, let's just refer people to the Quickstart guide: "See the Quickstart section for instructions on how to create these files manually or using docsify-cli."
(Quickstart section and docsify-cli should be linked)
docs/deploy.md
Outdated
| README.md | ||
| ``` | ||
|
|
||
| - Dockerfile |
There was a problem hiding this comment.
Making bullet names consistent: "Create dockerfile"
docs/deploy.md
Outdated
| Dockerfile | ||
| ``` | ||
|
|
||
| - Build Image |
There was a problem hiding this comment.
Making bullet names consistent: "Build docker image"
docs/deploy.md
Outdated
| docker build -f Dockerfile -t docsify/demo . | ||
| ``` | ||
|
|
||
| - Run |
There was a problem hiding this comment.
Making bullet names consistent: "Run docker image"
|
Nice work, @Koooooo-7. Thanks for being patient with all of the change requests. :) |
yep, I agree.
Glad to make it concise and accurate . xD |
* develop: docs: removed codefund docs and plugin (#1262) docs: remove bundle size from the home page and documentation (#1257) fix: search can not search the table header (#1256) fix: after setting the background image, the button is obscured (#1234) Fix: fixed onlycover flag in mobile (#1243) fix: Updated docs with instructions for installing specific version (fixes #780) (#1225) fix: Add error handling for missing dependencies (fixes #1210) (#1232) [documdocs: deploy docsify in docker. (#1241) docs: Add embed gist instructions to Embed Files (fixes #932 ) (#1238) chore: add changelog 4.11.4 [build] 4.11.4 feat: added html sanitizer for remote rendering (#1128)
Summary
A toturial about building docsify in docker.
Docker is getting more popular, so I wanna rich the deploy ways for docsify.
What kind of change does this PR introduce? (check at least one)
If changing the UI of default theme, please provide the before/after screenshot:
Does this PR introduce a breaking change? (check one)
If yes, please describe the impact and migration path for existing applications:
The PR fulfills these requirements:
fix #xxx[,#xxx], where "xxx" is the issue number)You have tested in the following browsers: (Providing a detailed version will be better.)
If adding a new feature, the PR's description includes:
To avoid wasting your time, it's best to open a feature request issue first and wait for approval before working on it.
Other information:
libdirectory.