Commit Graph

28 Commits (0de305a9a3b795d7938a654b263083bdad8e6453)

Author SHA1 Message Date
sammyette 0de305a9a3
docs: fix extra whitespace 2023-12-25 19:52:16 -04:00
sammyette 2cac53d6e7
feat(commands/doc): display separator, add space in code block 2023-12-18 10:16:57 -04:00
sammyette 7f6c459ba2
docs: fix extra backtick in codeblock 2023-12-17 22:20:41 -04:00
sammyette 393b2009bf
fix(docgen): add double space after line of text 2023-12-02 08:22:40 -04:00
sammyette 2363e6ff2f
website(docs): add example 2023-11-30 18:30:54 -04:00
sammyette 0f923a6f80
chore: merge from master 2023-11-11 21:57:15 -04:00
sammyette 29e14c1aee
feat: native modules (#257) 2023-11-11 19:39:31 -05:00
sammyette 726082ba03
docs: fix duplicate functions header 2023-09-09 13:38:54 -04:00
sammyette 7fd2ed391b
docs: add separators for types, make object properties into tables 2023-09-02 16:11:57 -04:00
sammyette 0900284304
docs: turn properties list into a table
also fix member functions causing a spam of separators
2023-09-02 16:01:57 -04:00
sammyette aa7e899db4
docs: make various style changes
- add a table that lists module functions
- add highlight when jumping to a function
- separators
2023-09-02 14:18:40 -04:00
sammyette 81b7e20cbf
docs: add better introduction for bait module
also highlights codeblocks better
2023-09-02 12:57:13 -04:00
sammyette 7c1984135b
docs: add detailed parameter listing, change interface to modules
there are a few changes here
- documentation of each parameter separately has been added
to the generated text docs
- interfaces have been renamed to modules. this was honestly a pointless
and confusing distinction (interfaces are tables for modules that are
lua modules). it also makes it so that (formerly) interfaces and
modules line up with each other on the doc list

im not sure what else i did, these are old changes
2023-08-26 11:30:51 -04:00
sammyette 61914f8dc7
docs: add docs for sink type (closes #233) 2023-02-07 15:39:22 -04:00
sammyette 2f6ab5fd92
feat: add sink for commanders to write output/read input (#232)
to write output, you would usually just use the print builtin
since commanders are just lua custom commands but this does not
consider the fact of pipes or other shell operators being used
to redirect or whatever.

this adds readable/writable "sinks" which is a type for input
or output and is currently only used for commanders but can be
used for other hilbish things in the future
2023-01-20 19:07:42 -04:00
sammyette 6530d48b00
docs: document types properly (#227) 2023-01-18 06:39:26 -04:00
sammyette e5eefb1d2d
refactor!: rework docs and doc command (#218)
changes the actual file format of docs to markup since that's basically what we have been
using in the first place.

the docgen command has been modified to write markdown headings with the function name and
yaml metadata for easy consumption by hugo for the website.

all other docs have been moved to markdown as well this is the main reason this is a "breaking" change
users will have to reinstall hilbish (task uninstall and task install) to remove the old plaintext docs
2022-12-15 00:00:54 -04:00
TorchedSammy b712efd278
fix(docgen): make functions that take varargs have the signature 2022-04-04 21:34:46 -04:00
TorchedSammy e75c60ff49
feat(docgen): support outputting emmylua sources (closes #91) 2022-02-25 18:00:18 -04:00
TorchedSammy d1b7515722
fix(docgen): remove trailing spaces in docs 2022-02-24 20:42:54 -04:00
TorchedSammy b468727a32
refactor(docgen): remove global doc 2022-02-24 20:37:13 -04:00
TorchedSammy 82b4fa5e7c
fix(docgen): revert "fix(docgen): trim trailing space from doc comments"
This reverts commit 3f1f698511.
removes the newlines, dont do this for now
2021-12-07 17:08:25 -04:00
TorchedSammy 3f1f698511
fix(docgen): trim trailing space from doc comments 2021-12-07 16:57:53 -04:00
sammyette 3d53e85fc9
feat: add terminal package
a simple, smaller but lower level terminal library, mainly used to set
raw mode. functions:
size, save and restore current state, set raw mode. documentation is in
docs/terminal.txt or `doc terminal` in hilbish
2021-10-17 16:10:57 -04:00
sammyette 54635072f6
fix(docgen): use better perm mask for output files and folder 2021-10-16 15:38:17 -04:00
sammyette a2f54b627b
feat: output docs to a docs folder, allow multiline docs 2021-10-16 12:38:46 -04:00
sammyette 1689d80721
feat: add docgen program, document almost all hilbish functions 2021-10-16 10:21:05 -04:00
sammyette ecbcf9a968
feat: add docgen program 2021-10-15 23:58:56 -04:00