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

🚀 Docs Site Improvements #4319

Merged
merged 107 commits into from
Jan 20, 2023
Merged
Show file tree
Hide file tree
Changes from 87 commits
Commits
Show all changes
107 commits
Select commit Hold shift + click to select a range
ac1ed7a
Make `parsed` optional in `parsed as`
AyhamAl-Ali Jul 14, 2021
ea16c56
First Improvements Phase
AyhamAl-Ali Sep 4, 2021
3b84d57
Fixes
AyhamAl-Ali Sep 4, 2021
184bbac
🛠 Sections + Improvements
AyhamAl-Ali Sep 4, 2021
37973b5
Forgot search fixes
AyhamAl-Ali Sep 4, 2021
b919563
🚀 Another Update
AyhamAl-Ali Sep 10, 2021
5a40e85
Sections update & much more fixes
AyhamAl-Ali Sep 11, 2021
465b294
🛠 SyntaxHighlighting + Improvements
AyhamAl-Ali Sep 23, 2021
2be2d9f
🚀 'New' Tab and much more
AyhamAl-Ali Sep 25, 2021
7c48499
🛠 Mobile CSS fixes
AyhamAl-Ali Sep 25, 2021
c1c9dd0
🛠 Little CSS fixes
AyhamAl-Ali Sep 25, 2021
fae6a09
🛠 Item type text color
AyhamAl-Ali Sep 25, 2021
cfd45cc
🛠 Quick improvements and fixes
AyhamAl-Ali Oct 1, 2021
549b58e
Merge remote-tracking branch 'origin/master' into ench/docs-site-impr…
AyhamAl-Ali Nov 2, 2021
c880441
Improvements
AyhamAl-Ali Nov 2, 2021
56d2cf6
Add Javadocs
AyhamAl-Ali Nov 2, 2021
d906df7
Revert "Add Javadocs"
AyhamAl-Ali Nov 2, 2021
c04d51c
Add javadocs navbar item
AyhamAl-Ali Nov 2, 2021
8c6adfc
Merge remote-tracking branch 'origin/master'
AyhamAl-Ali Nov 4, 2021
87922a3
Merge remote-tracking branch 'AyhamAl-Ali/master'
AyhamAl-Ali Nov 27, 2021
d0e53b0
Merge branch 'master' into ench/docs-site-improvements
AyhamAl-Ali Dec 22, 2021
6bf907e
Merge branch 'master' into ench/docs-site-improvements
AyhamAl-Ali Jan 26, 2022
17b1405
A quick checkpoint
AyhamAl-Ali Jan 30, 2022
8cb70a0
Merge branch 'master' into ench/docs-site-improvements
AyhamAl-Ali Jan 30, 2022
57e2b3f
🚀 Should be ready now
AyhamAl-Ali Feb 1, 2022
1763f42
Fixes
AyhamAl-Ali Feb 2, 2022
93fe6e3
Quick fix for example spaces
AyhamAl-Ali Feb 2, 2022
cefd4dd
Improvements
AyhamAl-Ali Feb 8, 2022
b4475a1
Improve new.html again & fix jQuery loading order
AyhamAl-Ali Feb 8, 2022
5a86355
Fix chrome scrolling issue that caused more issues
AyhamAl-Ali Feb 8, 2022
9229431
Imrpovements
AyhamAl-Ali Feb 8, 2022
92ae020
Fix black theme flicker when on white theme on load
AyhamAl-Ali Feb 8, 2022
e064577
Fix white theme flickering (again)
AyhamAl-Ali Feb 10, 2022
da28176
Merge branch 'master' into ench/docs-site-improvements
AyhamAl-Ali Feb 13, 2022
88ae93c
JS Improvements
AyhamAl-Ali Feb 15, 2022
cbaaf27
Improve auto hash scroll
AyhamAl-Ali Feb 15, 2022
6ef2fb9
Quick commit
AyhamAl-Ali Feb 17, 2022
ff2f942
⚒️ Improvements + Addition
AyhamAl-Ali Feb 19, 2022
cb2dcdf
🚀 Link return type section to their classes if found
AyhamAl-Ali Feb 19, 2022
3c44b4c
🚀 Change `force generate hooks` requirement
AyhamAl-Ali Feb 19, 2022
ecbe3da
Last touches
AyhamAl-Ali Feb 24, 2022
57001b6
Merge branch 'master' into ench/docs-site-improvements
AyhamAl-Ali Feb 24, 2022
1ff30b7
Forgotten commits :)
AyhamAl-Ali Feb 24, 2022
8f49c18
Merge remote-tracking branch 'AyhamAl-Ali/ench/docs-site-improvements…
AyhamAl-Ali Feb 24, 2022
ee19cb9
Fix #4429
AyhamAl-Ali Feb 24, 2022
7de40b7
Fix searching by id for events
AyhamAl-Ali Feb 24, 2022
de5598c
Improve hash link handling
AyhamAl-Ali Feb 24, 2022
325b091
Fix regex patterns for unsupported browsers
AyhamAl-Ali Feb 26, 2022
5b3af96
Apply suggestions from code review
AyhamAl-Ali Feb 26, 2022
4aa40a1
Fix compilation
AyhamAl-Ali Feb 26, 2022
b532ed7
Merge remote-tracking branch 'AyhamAl-Ali/ench/docs-site-improvements…
AyhamAl-Ali Feb 26, 2022
945c3c7
Merge remote-tracking branch 'origin/master'
AyhamAl-Ali Mar 15, 2022
869e811
Parts of the requested changes
AyhamAl-Ali Mar 15, 2022
2030d7a
Merge branch 'master' into ench/docs-site-improvements
AyhamAl-Ali Mar 15, 2022
cae629b
Docs: fix old info on dates - add new ways to get them
oskarkk Mar 22, 2022
526fc26
Docs: fix old info on dates - more precisely
oskarkk Mar 22, 2022
f712a66
Docs: fix old info on dates - add new ways to get them (#1)
AyhamAl-Ali Mar 22, 2022
1d5aff7
Requested Changes
AyhamAl-Ali Mar 28, 2022
b393b15
Update and rename ExprFormatTime.java to ExprFormatDate.java
NotSoDelayed Apr 7, 2022
abeecc7
Merge pull request #3 from DelayedGaming/ench/docs-site-improvements
AyhamAl-Ali Apr 7, 2022
5286349
Merge branch 'master' into ench/docs-site-improvements
AyhamAl-Ali Apr 7, 2022
aa374b3
Update main.js
AyhamAl-Ali Apr 25, 2022
2bb6a5c
Merge remote-tracking branch 'AyhamAl-Ali/ench/docs-site-improvements…
AyhamAl-Ali Apr 25, 2022
6169d00
Merge branch 'master' into ench/docs-site-improvements
AyhamAl-Ali Apr 25, 2022
d3779c9
Tests bump
AyhamAl-Ali May 2, 2022
fcd30e9
Update src/main/java/ch/njol/skript/lang/function/Signature.java
AyhamAl-Ali Jun 17, 2022
a4a4a03
Update docs/text.html
AyhamAl-Ali Jun 17, 2022
1ba5696
RC
AyhamAl-Ali Jun 25, 2022
6e81eb9
Merge remote-tracking branch 'AyhamAl-Ali/ench/docs-site-improvements…
AyhamAl-Ali Jun 25, 2022
5b57387
Build fix
AyhamAl-Ali Jun 25, 2022
2e7eaf0
Discord RC - Part 1
AyhamAl-Ali Jun 25, 2022
9e9f510
Merge to master
AyhamAl-Ali Jul 11, 2022
cfac330
Improvements
AyhamAl-Ali Jul 14, 2022
9703b98
Improvements 2
AyhamAl-Ali Jul 14, 2022
d8b5a8d
Improvements 3
AyhamAl-Ali Jul 14, 2022
fee8a0c
Fix copy link not working as expected
AyhamAl-Ali Jul 14, 2022
20091c0
Improvements 4
AyhamAl-Ali Jul 14, 2022
1f20be7
Improve inline code BG on white theme
AyhamAl-Ali Jul 14, 2022
934c524
Merge branch 'master' into ench/docs-site-improvements
AyhamAl-Ali Jul 14, 2022
035cc59
Stop cleaning patterns of classinfos
AyhamAl-Ali Jul 14, 2022
458064f
RC 1
AyhamAl-Ali Jul 15, 2022
5e6a06a
Mark pages as English language
AyhamAl-Ali Jul 15, 2022
99e8506
Make Signature#originClassPath nullable in more places
AyhamAl-Ali Jul 19, 2022
715e4dc
Filter Sections that are effect sections if isDocsPage
AyhamAl-Ali Jul 19, 2022
d99ce87
Create fields and getters for docs and template directory
AyhamAl-Ali Jul 20, 2022
4c67829
Removed commented line
AyhamAl-Ali Jul 20, 2022
e4cf2e1
Update Icons, favicon and logos
AyhamAl-Ali Jul 30, 2022
0c17f51
Update src/main/java/ch/njol/skript/doc/Documentation.java
AyhamAl-Ali Aug 9, 2022
e546523
Update src/main/java/ch/njol/skript/doc/Documentation.java
AyhamAl-Ali Aug 9, 2022
4d2b0b8
Improvements
AyhamAl-Ali Aug 20, 2022
cb490b0
Move annotatedComparator field up
AyhamAl-Ali Aug 20, 2022
18bd8fc
Requested Changes
AyhamAl-Ali Aug 21, 2022
e47dd7e
Fix localStorage expiration date
AyhamAl-Ali Aug 25, 2022
3b94243
Merge remote-tracking branch 'origin/master' into ench/docs-site-impr…
AyhamAl-Ali Aug 25, 2022
d62be0e
Merge branch 'master' into ench/docs-site-improvements
AyhamAl-Ali Sep 9, 2022
55d9c73
Fix build
AyhamAl-Ali Sep 9, 2022
1fb73d6
Merge remote-tracking branch 'origin/master' into ench/docs-site-impr…
AyhamAl-Ali Oct 23, 2022
8a4bac1
Add Cookies Accept Bottom Bar
AyhamAl-Ali Oct 28, 2022
2747763
Fix a quick error in cookies bar
AyhamAl-Ali Oct 28, 2022
c76beaf
Fix cookies bar off-screen
AyhamAl-Ali Oct 28, 2022
dafd6b1
Improve styling of cookies bar
AyhamAl-Ali Oct 28, 2022
e4811d4
Add keywords functionality
Pikachu920 Dec 16, 2022
9b9d886
Remove wildcard import
Pikachu920 Dec 16, 2022
cb88006
Merge branch 'master' into ench/docs-site-improvements
TheLimeGlass Jan 11, 2023
1f6173f
Go in to manually fix conflicts
TheLimeGlass Jan 11, 2023
8b42829
Fix couple bugs ([on] & classes)
AyhamAl-Ali Jan 19, 2023
e5bb7bd
Merge branch 'master' into ench/docs-site-improvements
AyhamAl-Ali Jan 20, 2023
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
13 changes: 10 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@

Skript's features are documented directly in it's Java code. But we still need

1. HTML, CSS and (possible) Javascript code to create website out of these
2. Clear tutorials, not just "you can check the syntax pattern"
3. Examples explained, if needed
1. Clear tutorials, not just "you can check the syntax pattern"
2. Examples explained, if needed

When generating final result, each HTML file is surrounded by template.html,
which provides head element, navigation bar and so on.
Expand All @@ -26,3 +25,11 @@ include <filename> - Load given file and place them here
generate <expressions/effects/events/types/functions> <loop template file> - Generated reference
content - In template.html, marks the point where other file is placed
```

## Generating the documentation

1. You will need to create a directory named `doc-templates` in `plugins/Skript/`, and copy everything from [here](https://github.com/SkriptLang/Skript/tree/master/docs) into that directory.
2. Execute the command `/sk gen-docs`.
3. The `docs/` directory will be created _(if not created already)_ in `plugins/Skript` containing the website's files.
4. Open `index.html` and browse the documentation.
5. _(Optionally)_ Add this system property `-Dskript.forceregisterhooks` in your server startup script (before the -jar property) to force generating hooks docs.
Binary file removed docs/assets/Logo/Skript Logo Circle 2.png
Binary file not shown.
Binary file removed docs/assets/Logo/Skript Logo Circle.png
Binary file not shown.
Binary file added docs/assets/Logo/Skript Logo Circular.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/assets/Logo/Skript Logo Trans.png
Binary file not shown.
Binary file added docs/assets/Logo/Skript Logo.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/Logo/Skript Logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
70 changes: 70 additions & 0 deletions docs/assets/light-off.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
114 changes: 114 additions & 0 deletions docs/assets/light-on.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading