proxmox-mirrors/pve-docs
1
0
Fork 0
mirror of https://git.proxmox.com/git/pve-docs synced 2025-05-21 17:27:48 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix spelling errors, add target to create README.html

Browse Source
This commit is contained in:
Dietmar Maurer 2016-09-23 09:28:14 +02:00
parent d067c2ad94
commit 9d17dbacc4
2 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Makefile
View File

@ -206,6 +206,9 @@ pmxcfs.8.html: pmxcfs.adoc pmxcfs.8-cli.adoc ${PVE_COMMON_DOC_SOURCES}
%.5-plain.html: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES} %.5-plain.html: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
asciidoc -s ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc asciidoc -s ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc
README.html: README.adoc
asciidoc ${ADOC_STDARG} -o $@ $<
.PHONY: index .PHONY: index
index: index.html index: index.html
$(BROWSER) index.html & $(BROWSER) index.html &

6
README.adoc
View File

@ -37,7 +37,7 @@ build time.
Another package called 'pve-docs' is used to publish generated Another package called 'pve-docs' is used to publish generated
'.html' and '.pdf' files on our web servers. You can generate '.html' and '.pdf' files on our web servers. You can generate
those debian packages using: those Debian packages using:
make deb make deb
@ -82,7 +82,7 @@ below the title text:
Level 3: ^^^^^^^^^^^^^^^^^^^^^^ Level 3: ^^^^^^^^^^^^^^^^^^^^^^
Level 4 (bottom level): ++++++++++++++++++++++ Level 4 (bottom level): ++++++++++++++++++++++
Section titles should always be preceeded by two empty lines. Each word Section titles should always be preceded by two empty lines. Each word
in a title should be capitalized except for ``articles, coordinating in a title should be capitalized except for ``articles, coordinating
conjunctions, prepositions, and the word to in infinitives unless they conjunctions, prepositions, and the word to in infinitives unless they
appear as the first or last word of a title'' (see appear as the first or last word of a title'' (see
@ -128,7 +128,7 @@ Labeled Lists
^^^^^^^^^^^^^ ^^^^^^^^^^^^^
Labeled lists should be used to make lists of key-value style text Labeled lists should be used to make lists of key-value style text
more readable, such as command line parameters or config options: more readable, such as command line parameters or configuration options:
.Regular labeled lists .Regular labeled lists
----- -----