Add user manual.
continuous-integration/drone/push Build is passing Details

This commit is contained in:
CismonX 2021-03-29 02:46:49 +08:00
parent f89d9026a1
commit 181942a8cd
Signed by: cismonx
GPG Key ID: 3094873E29A482FB
5 changed files with 87 additions and 0 deletions

1
.gitignore vendored
View File

@ -8,5 +8,6 @@
*.vsix
.vscode/
doc/version.texi
node_modules/
out/

View File

@ -14,6 +14,7 @@
.gitattributes
.travis.yml
.vscode/
doc/
LICENSE_NOTICE.md
node_modules/
src/

View File

@ -8,6 +8,13 @@ this notice are preserved. This file is offered as-is, without any warranty.
# Changelog
## v0.2.0 - 03/31/2021
* Add a status bar item showing the current installation status of GNU Texinfo.
* Add user manual.
* Minor refactor of source code.
* Change license from MIT to GPL-3.0-or-later.
## v0.1.4 - 02/23/2021
* Support loading custom CSS for HTML preview.

75
doc/vscode-texinfo.texi Normal file
View File

@ -0,0 +1,75 @@
\input texinfo @c -*-texinfo-*-
@c %**start of header
@setfilename vscode-texinfo.info
@include version.texi
@settitle vscode-texinfo v@value{VERSION} User Manual
@c %**end of header
@copying
This manual is for vscode-texinfo, an extension of Visual Studio Code.
Copyright @copyright{} 2021 CismonX <admin@@cismon.net>
@quotation
Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty, provided the copyright notice and
this notice are preserved. This file is offered as-is, without any warranty.
@end quotation
@end copying
@titlepage
@title vscode-texinfo
@subtitle Texinfo Support for Visual Studio Code, version @value{VERSION}
@author CismonX
@page
@vskip 0pt plus 1filll
@insertcopying
@end titlepage
@summarycontents
@contents
@ifnottex
@node Top
@top vscode-texinfo
This manual is for vscode-texinfo, an extension of Visual Studio Code.
Copyright @copyright{} 2021 CismonX <admin@@cismon.net>
Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty, provided the copyright notice and
this notice are preserved. This file is offered as-is, without any warranty.
@end ifnottex
@menu
* Overview:: Brief overview of vscode-texinfo.
* Installation:: Install vscode-texinfo.
* Basic Usage:: Basic features of vscode-texinfo.
* Advanced Usage:: Advanced features of vscode-texinfo.
@end menu
@node Overview
@chapter Overview
@node Installation
@chapter Installation
@node Basic Usage
@chapter Basic Usage
@node Advanced Usage
@chapter Advanced Usage
@bye

View File

@ -12,3 +12,6 @@ DEST_PATH=./out/grammars
mkdir -p $DEST_PATH
# Convert TextMate grammar from CSON to JSON, as VSCode cannot recognize CSON ones.
cson2json $SRC_PATH/grammars/texinfo.cson | json -j0 > $DEST_PATH/texinfo.json
VERSION=$(json -f package.json version)
echo "@set VERSION $VERSION" > ./doc/version.texi