Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Overhaul of the Manual #3189

Open
wants to merge 90 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
90 commits
Select commit Hold shift + click to select a range
1e92e34
Generate docs from Markdown with Pandoc.
01mf02 Sep 30, 2024
9f7da22
GitHub Actions.
01mf02 Sep 30, 2024
6bd5c30
Do not build docs by default for now.
01mf02 Sep 30, 2024
6d193b6
Support note blocks.
01mf02 Oct 1, 2024
b8b8696
New structure for the manual.
01mf02 Oct 1, 2024
a5ee22c
Small improvements here and there.
01mf02 Oct 1, 2024
71cf646
Grammar.
01mf02 Oct 1, 2024
67d0716
Simpler handling of different block types.
01mf02 Oct 2, 2024
684d4e5
Enhance manual.
01mf02 Oct 2, 2024
ea59c0d
Example block.
01mf02 Oct 2, 2024
cd393ad
More on path expressions.
01mf02 Oct 2, 2024
1467298
Explanation.
01mf02 Oct 2, 2024
0b0cf29
Move stuff around, more on `and` and `or`.
01mf02 Oct 2, 2024
261f0bc
Work on man page.
01mf02 Oct 2, 2024
4c4a641
CLI.
01mf02 Oct 3, 2024
9f2b4df
Include subsections in TOC.
01mf02 Oct 4, 2024
55b7667
Modules, comments.
01mf02 Oct 4, 2024
9b6aff3
Indent subsections more nicely.
01mf02 Oct 4, 2024
b7cec85
Remove inactive button.
01mf02 Oct 4, 2024
fb181f0
(Re)move section.
01mf02 Oct 4, 2024
e2f29d0
Use details/summary for navigation.
01mf02 Oct 5, 2024
d269c13
Correct chevron behaviour on Chrome.
01mf02 Oct 5, 2024
d3ed376
Introduce blocks in man page.
01mf02 Oct 7, 2024
45befbf
Explanations.
01mf02 Oct 7, 2024
0b6902b
Document reduction with multiple output values.
01mf02 Oct 7, 2024
fa0b116
Definitions.
01mf02 Oct 7, 2024
e28245b
Scoping.
01mf02 Oct 8, 2024
f2f12f3
Start work on assignment.
01mf02 Oct 8, 2024
ac39187
Assignments.
01mf02 Oct 8, 2024
107b795
Complex assignments.
01mf02 Oct 9, 2024
f4cc5b4
Make tests a bit shorter and more precise.
01mf02 Oct 9, 2024
c205cf8
More on path expressions.
01mf02 Oct 9, 2024
5b61057
Moving.
01mf02 Oct 9, 2024
f4b39fa
Regenerate man page / tests.
01mf02 Oct 9, 2024
ea3881b
Document new `skip` function (03fa79c3bad2a47765265debdfe7dbe7d77df586).
01mf02 Oct 9, 2024
0c681c6
Rebuild tests / man page.
01mf02 Oct 9, 2024
4b4a5f7
Spacing.
01mf02 Oct 9, 2024
471b16e
Address @pkoppstein's remarks.
01mf02 Oct 10, 2024
b914c1e
Update man page.
01mf02 Oct 10, 2024
751e7bb
Make an example that shows how reduction handles destructuring.
01mf02 Oct 11, 2024
0f1b7fa
Second round of @pkoppstein's comments.
01mf02 Oct 15, 2024
c59ce73
Shorten examples in man page.
01mf02 Oct 15, 2024
c4c904f
Use definition lists for all non-HTML targets.
01mf02 Oct 15, 2024
808ac8c
Correct a few dangling references.
01mf02 Oct 15, 2024
8fc4307
Inline code for HTML and code blocks for everyone else.
01mf02 Oct 15, 2024
637fcb1
Clarify `input` behaviour, thanks to @pkoppstein.
01mf02 Oct 15, 2024
ac1cf5d
Move note about number representations from `.` to numbers section.
01mf02 Oct 15, 2024
529530e
Update tests / man page.
01mf02 Oct 15, 2024
d84ee39
Remake the objects subsection.
01mf02 Oct 16, 2024
20299eb
Remake destructuring subsection.
01mf02 Oct 16, 2024
ea8d171
Destructuring in reduction operators.
01mf02 Oct 17, 2024
23fa7d2
jaq supports `foreach/3` now.
01mf02 Oct 17, 2024
0c67e5f
jq -> jaq.
01mf02 Oct 17, 2024
1aa80cd
Spaces.
01mf02 Oct 17, 2024
a5fe551
Clearer equivalence.
01mf02 Oct 17, 2024
53f5fe5
Input of `(f)` in object pattern keys.
01mf02 Oct 17, 2024
52ce795
Split multiple outputs into multiple lines.
01mf02 Nov 6, 2024
80ebbfe
Be more explicit about ignoring input.
01mf02 Nov 6, 2024
80d0631
Integrate first round of @wader's comments.
01mf02 Nov 6, 2024
74c4e65
jaq now supports escaped comments.
01mf02 Nov 6, 2024
4bbc505
Document compound paths binding order.
01mf02 Nov 6, 2024
0c0a64c
Correct typo.
01mf02 Nov 6, 2024
1dbbb14
Integrate @wader's comments on if-then-else.
01mf02 Nov 6, 2024
1539242
Correct typo.
01mf02 Nov 6, 2024
1c50e64
More @wader suggestions.
01mf02 Nov 6, 2024
828e6f1
More of @wader's comments.
01mf02 Nov 14, 2024
0fda087
Clarify -f argument parsing #3199.
01mf02 Nov 14, 2024
a824612
Add --library-path long option for -L.
01mf02 Nov 14, 2024
18575e0
Remove outdated FIXME, see eb9bdca.
01mf02 Nov 14, 2024
cb8e2d8
Document that `last(empty)` yields no output values (#3179).
01mf02 Nov 14, 2024
d21e4ac
Update man-page & tests.
01mf02 Nov 14, 2024
642e126
Merge branch 'master' into manual-remake
01mf02 Nov 28, 2024
0df5f1f
Regenerate jq.1.prebuilt and man.test.
01mf02 Nov 28, 2024
d6f7822
Correct test input syntax.
01mf02 Nov 28, 2024
8c62801
Correct a few more tests.
01mf02 Nov 28, 2024
ba07eae
Correct outdated compatibility statements.
01mf02 Nov 28, 2024
84edae9
Generate anchor links.
01mf02 Dec 4, 2024
dc0fb26
Annotate sections with nicer IDs, correct a few references.
01mf02 Dec 4, 2024
e448df6
Add anchor links after headline for HTML.
01mf02 Dec 4, 2024
7bad736
Style examples button.
01mf02 Dec 4, 2024
2de38c8
Adapt example running buttons.
01mf02 Dec 4, 2024
6300bc0
Move Markdown manual to `manual/dev/manual.md`.
01mf02 Dec 9, 2024
b02f348
Add generated, temporary `manual.yml` to `.gitignore`.
01mf02 Dec 9, 2024
6cc5b41
Use default arrow for `<details>`.
01mf02 Dec 9, 2024
fa79d81
Integrate @itchyny's comments.
01mf02 Dec 9, 2024
84e3ec7
Update man page.
01mf02 Dec 9, 2024
7382953
Apply `small` class to `<details>` instead of `<summary>`.
01mf02 Jan 6, 2025
549dcdc
Correct path grammar.
01mf02 Jan 6, 2025
94592ca
Update man page.
01mf02 Jan 6, 2025
0529bde
Omit formal grammar for paths.
01mf02 Jan 7, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Support note blocks.
  • Loading branch information
01mf02 committed Oct 1, 2024
commit 6d193b6aac51db330a878c99c57c1d37d7e154e7
7 changes: 7 additions & 0 deletions docs/filters/filter.lua
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,14 @@ function Div(el)
}
end
return el.content
elseif el.classes:includes'Note' then
el.classes = {"alert", "alert-primary"}
table.insert(el.content, 1, pandoc.Span("Note", {class = "block-start"}))
elseif el.classes:includes'Compatibility' then
el.classes = {"alert", "alert-primary"}
table.insert(el.content, 1, pandoc.Span("Compatibility", {class = "block-start"}))
end
return el
end

function example(test)
Expand Down
10 changes: 10 additions & 0 deletions docs/public/css/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,16 @@ section[id] {
--bs-offcanvas-width: auto;
}

.alert > :last-child {
margin-bottom: 0;
}

.block-start {
float: left;
margin-right: 1rem;
font-weight: bold;
}

ul {
list-style: none;
padding-left: 1rem;
Expand Down