Commit Graph

327 Commits

Author SHA1 Message Date
Der Teufel 656b9429d0 autodoc: An attempt at generating HTML files from all imported source
files. Files generated from the standard library could be considered
for placing with main.js and index.html in lib/docs. Paths should
reflect packages in the future.
2022-08-18 14:03:42 +02:00
Loris Cro 7f7d58ee89 Merge branch 'master' into autodoc-links 2022-08-16 16:52:26 +02:00
Loris Cro 5929da37a1 autodoc: absolute line numbers in decl [src] links 2022-08-16 16:51:32 +02:00
Loris Cro 0a0b3dda03 autodoc: remove reference to github, replace with placeholder link 2022-08-16 16:19:54 +02:00
r00ster91 78bb29d1dc fix: scroll page to very top when S is pressed
Credits go to @rudedogg
2022-08-14 19:19:44 +02:00
r00ster91 af20dfae60 bug: add TODO 2022-08-14 12:20:26 +02:00
r00ster91 e5379e5027 docs: add comment 2022-08-14 12:18:08 +02:00
r00ster91 2723d8e6e2 style: format
Some formatting, apparently.
2022-08-14 11:54:51 +02:00
r00ster91 8f6f4bc7ca feat: make modal more restrictive and more Esc freedom
This makes it so that you can no longer interact with the search bar
or the results or anything while the modal is open. That's why it's a "modal" and not a "dialog".

It also makes it so that you can now always press Esc to return to the results or the main page.
Previously this was only possible when the search field was active.
2022-08-14 11:54:51 +02:00
r00ster91 9900413eb1 feat: indent keyboard shortcuts
This indents the keyboard shortcuts related to the S key because you can only
use these keyboard shortcuts after you pressed S (when the search field is focused).
This is a visual hint.
2022-08-14 11:54:51 +02:00
r00ster91 e1eaa1f7d6 fix: var(--mono) used for font-size 2022-08-14 11:54:51 +02:00
r00ster91 dc5174440c feat: better No Results Found page
This adds some helpful links to the page and makes it look nicer by using <kbd> etc.
2022-08-14 11:54:51 +02:00
Maciej 'vesim' Kuliński a0a1178694 autodoc: links to source code 2022-08-08 21:42:38 +02:00
r00ster91 ff6d2e632f fix: cleanup recent changes 2022-08-08 18:14:26 +02:00
zooster 3debd6b732 Merge branch 'master' into nicedocs 2022-08-06 19:32:42 +02:00
Loris Cro cb7c912a1b autodoc: use location.replace to avoid history spam when searching 2022-08-06 17:29:39 +02:00
Loris Cro 9fc6990052 autodoc: re-introduce search result limits 2022-08-06 17:29:13 +02:00
r00ster91 943f4eb515 fix: use brighter bg color for help modal in light mode
You can see this issue in the video.
2022-08-06 16:07:32 +02:00
r00ster91 60b04b0988 style: some more formatting 2022-08-06 16:01:43 +02:00
r00ster91 2f5afe1194 let -> const for dom elements
These should never be reassigned.
2022-08-06 15:53:20 +02:00
r00ster91 e921dd1136 style: missing semi 2022-08-06 15:38:32 +02:00
r00ster91 beba29c24f feat: make shadow of <kbd>s look nicer 2022-08-06 15:34:38 +02:00
r00ster91 ee72868f92 style: format
This is mostly manually formatted. I couldn't find a good HTML formatter for this file.
It also converts a bunch of tabs to spaces.
2022-08-06 15:34:00 +02:00
r00ster91 2f0abe63d4 fix: disable search bar before loading
This fixes the new search placeholder not disappearing if you type before
it finished loading, and maybe some other things.
2022-08-06 15:16:27 +02:00
r00ster91 df8cfb1273 feat: new search placeholder
This new search placeholder looks much nicer because it allows HTML inside it which
the `placeholder` attribute on `<input>`s doesn't allow.
I tested it for all kinds of cases and it seems to work pretty well.
2022-08-06 15:15:59 +02:00
r00ster91 6354851909 fix: "dialog" -> "modal"
"Dialog" is the incorrect term here because a dialog is a separate window that still lets you use the app
but a modal is a window where you can't continue using the app until you close it.
2022-08-06 15:05:58 +02:00
r00ster91 4ef567ba41 feat: make help modal disappear if you click outside it 2022-08-06 15:01:55 +02:00
Austin Rude 7afe7de4f0 autodoc: only modify the DOM once to display the search results 2022-08-05 21:47:36 -06:00
Austin Rude e02f51762f autodoc: Run through prettier formatter with default settings 2022-08-05 16:01:57 -06:00
Loris Cro 7ffba492a5 autodoc: fix inconsistency when indexing generic types for search
closes #12334
2022-08-05 00:11:32 +02:00
Loris Cro 4c750016eb autodoc: inferred error unions in function return values 2022-08-03 17:21:56 +02:00
Loris Cro c5afefec42 autodoc: fix autodoc analysis for @typeInfo
We were previously erroneously saving it as a `@TypeOf`.
2022-08-02 17:49:36 +02:00
Loris Cro 622714b76b autodoc: fix frontend crash while rendering std.mem
Previously we expected to only find decl refs in a `foo.bar.baz`
type of expression. This would crash when trying to render something
like `@typeInfo(T).Int.bits`. We now properly account for builtins
and other components.
2022-08-02 17:49:36 +02:00
Loris Cro 2375658da9 Merge pull request #12276 from r00ster91/shortdesc
autodoc: better short description algorithm
2022-08-02 16:32:08 +02:00
Ryan Liptak 921ba6cad4 autodoc: Add borders to field docs to make it clear which field they are associated with 2022-07-30 17:26:29 -07:00
r00ster91 2c7387aef5 autodoc: better short description algorithm 2022-07-28 21:37:36 +02:00
Andrew Kelley aa1a06bf9b Autodoc: small polish on the html 2022-07-19 19:10:12 -07:00
Loris Cro 572f9a5602 Autodoc: add warning banner to html 2022-07-19 19:10:12 -07:00
Loris Cro ad7bc57919 autodoc: fix rendering of function arguments 2022-07-19 19:10:12 -07:00
Loris Cro 8ec34eb046 autodoc: handle result location instructions 2022-07-19 19:10:12 -07:00
Loris Cro 947eff6e39 autodoc: handle special case of autodoc for std 2022-07-19 19:10:12 -07:00
Vallahor fed9dcff24 autodoc: @as behavior in js 2022-07-19 19:10:12 -07:00
Vallahor 341431b15c autodoc: handling more values sections 2022-07-19 19:10:12 -07:00
Loris Cro 24a79426ec autodoc: update array analysis to new Zir 2022-07-19 19:10:12 -07:00
Vallahor 866bbb2e7a autodoc: fiedRef type rendering 2022-07-19 19:10:12 -07:00
Vallahor e7476fd81c autodoc: handling refPath and fieldRef 2022-07-19 19:10:12 -07:00
Vallahor 81147dd101 autodoc: initial work in opaque_decl 2022-07-19 19:10:12 -07:00
Loris Cro 45e3b1a23d autodoc: remove type annotations from main.js 2022-07-19 19:10:12 -07:00
Vallahor 02bd5fe93a autodoc: experiment get line info 2022-07-19 19:10:12 -07:00
Loris Cro d2baf404a5 autodoc: enabled packages 2022-07-19 19:10:12 -07:00