github.com/Open-Science-Community-Saudi-Arabia/JSquarto commits

update documentation

5a25142c2c37eeba5ee365480286cf105ab72e0b authored 7 months ago by RealRichi3 <[email protected]>

use only module name as title for tutorials

c4713e70d0edf7d19288349f2bbd3daf9e1e5ff4 authored 7 months ago by RealRichi3 <[email protected]>

mv docs

80c2fd2958b1b2f9351edb941a395f2d375e17db authored 8 months ago by RealRichi3 <[email protected]>

update gitignore

c109988b9b003c344ccee039f71f214e9452d718 authored 8 months ago by RealRichi3 <[email protected]>

copy generated doc to site dir

a8c76993a33c11e2005af20b1ecd6c5b65883810 authored 8 months ago by RealRichi3 <[email protected]>

rm docs from gitignore

a69e6d944916248bf722ec7b16b325c97dc4e20f authored 8 months ago by RealRichi3 <[email protected]>

Merge branch 'main' of https://github.com/Open-Science-Community-Saudi-Arabia/JSquarto into main

85d99596a3ba7c548edc87967ba1461376a5816b authored 8 months ago by RealRichi3 <[email protected]>

mv doc dir to docs/ instead of docs/_book

This is because github pages doesn't show the _book dir

6c0e14acd56d2854c862415f3595630b2b79abc6 authored 8 months ago by RealRichi3 <[email protected]>

Merge pull request #32 from Open-Science-Community-Saudi-Arabia/dev

[05/03/2024] MVP

d6fe7a7c5b3046ed7926172d2fa6e65f610089dd authored 8 months ago by Richie <[email protected]>

Merge branch 'main' into dev

bb323fec4e7dbd27e36525c7ebffc8996b33d880 authored 8 months ago by Richie <[email protected]>

Merge branch 'dev' into main

24d2a190b8fc96ab7a5d31721f91c72ae54ecc97 authored 8 months ago by RealRichi3 <[email protected]>

update readme

90aac13b1b912b917c61f501f13887144f24d848 authored 8 months ago by RealRichi3 <[email protected]>

update readme

01975b8f64c95c758c31db8fb100ca7d3942a7bf authored 8 months ago by RealRichi3 <[email protected]>

add: generated docs

836cdbe730af5f5e92a3613c5780f59c34765220 authored 8 months ago by RealRichi3 <[email protected]>

Merge branch 'tutorials' into dev

1c40fe4e67c7a27214b610de4b352ba8028587af authored 8 months ago by RealRichi3 <[email protected]>

add: npm script to install quarto

a2631b33ac0d4b1c2e1207a9c8d34de11105127e authored 8 months ago by RealRichi3 <[email protected]>

Merge pull request #30 from RealRichi3/tutorials

[04/02/2024] feat: Tutorials / How to guides, custom flags

52e5b2698169cdb4897a619175b3889679f8f579 authored 8 months ago by Richie <[email protected]>

update tutorials

93036cd914f5d54c84cce101a7610dc3ea43a976 authored 8 months ago by RealRichi3 <[email protected]>

add npm tag to specify source_files directory

ed5a807f35ff8f15141c0e0e0c28acf6ec3f764f authored 8 months ago by RealRichi3 <[email protected]>

Merge pull request #29 from RealRichi3/tutorials

[28/02/2024] feat: Update sample tutorials to JSquarto tutorials

0de6535b1ad00cb9d86e9af7fe3f9493fb681022 authored 8 months ago by Richie <[email protected]>

update

2b07e250ad191bf0bf973b10ca33ea531846e802 authored 8 months ago by RealRichi3 <[email protected]>

update guide for improving doc

e2ddeb1c1b3e75bd2da5d0484e8931146d274349 authored 8 months ago by RealRichi3 <[email protected]>

add: jsdoc comments for new methods in Writer class

761a7f66677711e0fceb22275cc945b2b9520c1f authored 8 months ago by RealRichi3 <[email protected]>

add: issue and pr templates

86be57696ccfad978fdc36fce63a6769d88c4ec7 authored 8 months ago by RealRichi3 <[email protected]>

update readme

2879babd5be57866f8d93f66d8950035a9c239ba authored 8 months ago by RealRichi3 <[email protected]>

update environment_setup tutorial

54e6361dd0894dfdb600716a9bc9a0f1453ca149 authored 8 months ago by RealRichi3 <[email protected]>

modularize logic to add tutorials to doc

c48aca157d004cb427b8c4f1ada3b3a25d22ae44 authored 8 months ago by RealRichi3 <[email protected]>

fix: tutorials without chapter not included in quarto.yaml

71452ce397d5542b76776149476bb64d306a0230 authored 8 months ago by RealRichi3 <[email protected]>

fix: tutorials writtne to /chapters instead of docs/chapters

5ef873632be84694bb7d0873d1eeda89a1eca9f6 authored 8 months ago by RealRichi3 <[email protected]>

rm unused tutorials

a4ad1eaea41ee4fb8fc6ea6540eb2b0d64d90b39 authored 8 months ago by RealRichi3 <[email protected]>

update tutorials on raising issues and pullrequests

d33b3e745da0fd8b57929c9e48afc4006e478874 authored 8 months ago by RealRichi3 <[email protected]>

update tutorial on improving the documentation

44d0df063b8e61d8e91fc6ba13861731b6583f0c authored 8 months ago by RealRichi3 <[email protected]>

Merge pull request #26 from RealRichi3/tutorials

[25/02/2024] feat: Tutorials

9def0aa3594bec00d6616601177085cf222dc199 authored 8 months ago by Richie <[email protected]>

rm duplication tutorial files

e9df04ed8d9b56c6c7f165746b9dbe1d7cf6986b authored 8 months ago by RealRichi3 <[email protected]>

include tutorial guide in readme

ad5a41bd3e49e040b559fa5c213c90a2f40f5bdf authored 8 months ago by RealRichi3 <[email protected]>

update readme

a02a66849a69369981f86824d5777288d691d783 authored 8 months ago by RealRichi3 <[email protected]>

add sample tutorial files

ff78546ba98913f2790a81eaf823eda3e341de2c authored 8 months ago by RealRichi3 <[email protected]>

set allowed file types to js

939400622cc53a18130a25ecd990ca0a6f20efd2 authored 8 months ago by RealRichi3 <[email protected]>

Merge pull request #25 from RealRichi3/code_docs

[20/02/2024]: Add code documentation

96598290c486e483b6e31bc16dd14df69dc3198d authored 8 months ago by Richie <[email protected]>

update

089c2d44f8100cbd6a2f571574be9c1ddd129b78 authored 8 months ago by RealRichi3 <[email protected]>

update

2b247a7c1e596c91db40931d51020c32aadd37d0 authored 8 months ago by RealRichi3 <[email protected]>

write tutorials to qmd

ba9e2e28c3cecb23952f5c3db4b3287795c416c2 authored 8 months ago by RealRichi3 <[email protected]>

successfully included tutorials in generated docs

bac5572ce573ac0f25a7925755d397056375fbfd authored 8 months ago by RealRichi3 <[email protected]>

add: comments

acac4d08e7f41aa980d32810284d17af4ee18794 authored 8 months ago by RealRichi3 <[email protected]>

feat: createModulesAndCategoriesFromTutorialsConfig

Added a feature to allow you specify how the tutorials should be arranged in the rendered and i...

6cc80962c1a9e68220cefdf8fd38e871f6cc585d authored 8 months ago by RealRichi3 <[email protected]>

set default dir for js file to

1d6462bbe3f6dc5079217062ac37d84fc54b31da authored 8 months ago by RealRichi3 <[email protected]>

specify source files path on npm script

976b42d626b6e02d12153681e4f5de713e2842cd authored 8 months ago by RealRichi3 <[email protected]>

add: option to specify sourceFolder dir from npm command

2778eda65bf928178dfbd1c8181fbd44fee7d2f4 authored 8 months ago by RealRichi3 <[email protected]>

add: code comments for utils

56e4d6d4686f0d8edd6cf4567221382537b5e59a authored 8 months ago by RealRichi3 <[email protected]>

add: comments for writer util

f2821c16d367c7300eac7442ad8083d1262d7abd authored 8 months ago by RealRichi3 <[email protected]>

update code doc for writer

ab58c38b9b17f680115016cafdc3601e4683cd6a authored 8 months ago by RealRichi3 <[email protected]>

add: doc for entry file

8f7920b8064d77986a177abd49fe11fef536347d authored 8 months ago by RealRichi3 <[email protected]>

clean code

24e4ac321b401fb1b0d116ea860e8dd73f2a3451 authored 8 months ago by RealRichi3 <[email protected]>

Update README.md

b8ca9abf0258d14e74f1857fa3786b5307bc14c8 authored 8 months ago by Batool Almarzouq <[email protected]>

Merge pull request #23 from Open-Science-Community-Saudi-Arabia/dev

[19/02/2024] Features for MVP

70137eb232fce65753dc345b9969940e9c1b1df5 authored 8 months ago by Richie <[email protected]>

Merge pull request #22 from RealRichi3/mvp

[18/02/2024] feat: reference doc snippets and external resources

cf2b8e6f902734f1e52dfd511d30df384e46bdeb authored 8 months ago by Richie <[email protected]>

test reference

599c3fa95fe33ad043c980df7822e75743a107f7 authored 8 months ago by RealRichi3 <[email protected]>

reference links working

b353c4589358d3f53dc1a4269e1edd2b8b00dc94 authored 8 months ago by RealRichi3 <[email protected]>

add links to file in references attached to doc

38651ef7f8fd743d5652e1761e14242aae67137c authored 8 months ago by RealRichi3 <[email protected]>

set folder/file naming conv to lowercase

21217497634afe2c0a4abea809a4ba275683d122 authored 8 months ago by RealRichi3 <[email protected]>

modify writer util to get references for externalModuleWithSubcategoryConstruct and externalModuleWithSubcategory

8059f0e3615909fd24387576511a7013eac90ebc authored 8 months ago by RealRichi3 <[email protected]>

modify reference type to include constructName

7642db1a7eb8cdc676c0cb62b449accbccf32922 authored 8 months ago by RealRichi3 <[email protected]>

feat: getReferences in parser

e884ba0728eb8a7a37def3d29042e47b0cdf6afb authored 8 months ago by RealRichi3 <[email protected]>

feat: getDirectoryForDocs

c2d3dc9bbb36ab3869f8d5ad2987dd85eb68b48a authored 8 months ago by RealRichi3 <[email protected]>

exclude categories without modules from _quarto.yml

9d5c0a258b323cf65ba7518692a5c2a6567576b0 authored 8 months ago by RealRichi3 <[email protected]>

Merge pull request #21 from RealRichi3/mvp

[17/02/2024]: Link unmatched documents to `Globals` category

8d4771cc270e39475bc9f63e78b8d5672cad8a2f authored 8 months ago by Richie <[email protected]>

fix: globals section appearing twice

5ace1d98fdc3eaddd7ca8226957a8dd066e68cc1 authored 8 months ago by RealRichi3 <[email protected]>

fix: modules without categories not linked to globals

38c51cfd9c5fc9232c3d5b5f47fbb77856636a58 authored 8 months ago by RealRichi3 <[email protected]>

Merge branch 'dev' of https://github.com/Open-Science-Community-Saudi-Arabia/JSquarto into mvp

99813126382f8b74a86a3eeb1e6b7a677b8ed02e authored 8 months ago by RealRichi3 <[email protected]>

include @examples in extracted comments, fixes (#19)

- Update parser to extract tag from comments
- Update writer to write in javascript format

fe716179a3f4e9cb294dc9e8eafffdb8108f7948 authored 8 months ago by RealRichi3 <[email protected]>

Merge pull request #18 from RealRichi3/mvp

[17/02/2024] Fix inconsistent header titles from extracted documents

a32c9e725b29d0af2b2e03b96bedfa1a7195751c authored 8 months ago by Richie <[email protected]>

fix: function regex to match const var = function () {}

a1d2daf60ebc15dac83dfd142b2d24ecbd6004ea authored 8 months ago by RealRichi3 <[email protected]>

fix: function code construct return false values for arrow function

d661227bf704407e947b0e53561ae1fef15d79ed authored 8 months ago by RealRichi3 <[email protected]>

change default name for global category

050c0b4e5c9ee0e942adae8d01368e5892683b62 authored 8 months ago by RealRichi3 <[email protected]>

Merge branch 'dev' of https://github.com/Open-Science-Community-Saudi-Arabia/JSquarto into mvp

96aa1a60e3554cf52217985f1b2c796fc2711291 authored 8 months ago by RealRichi3 <[email protected]>

improve content for default homepage (#11)

581987336cca053bfd75fbbe69140903cf5fcaa8 authored 8 months ago by RealRichi3 <[email protected]>

Merge pull request #15 from RealRichi3/MVP

Remove code construct from doc headings

f3a329a3a6386f14e023128eecf96e8716740596 authored 8 months ago by Richie <[email protected]>

only show description when it is included

3d21e617656df5fec1477bc4716959bcd1bb198f authored 8 months ago by RealRichi3 <[email protected]>

exclude code construct from doc headings

48d03e5563a8051ea4c26075253f078bd139c417 authored 8 months ago by RealRichi3 <[email protected]>

Merge pull request #14 from RealRichi3/mvp

Improve formatting for `params`, `thrown errors` and `return values` in doc

3b2882b24247cf344d4fa83c3dc27786d27b8acc authored 8 months ago by Richie <[email protected]>

rm test_file

98e63ae243127d4ab90c55c5a1d13597ede5cc0a authored 8 months ago by RealRichi3 <[email protected]>

change formatting for to tabular form

0c9c579fcd8774b2059163c9af02df3e6df3750b authored 8 months ago by RealRichi3 <[email protected]>

fix: unresolve merge conflict

d03b0ebc384edc63a300ae27ccc2f68b60f0eb0f authored 8 months ago by RealRichi3 <[email protected]>

Merge pull request #7 from RealRichi3/docStructureGenerator

[08/02/2024] Generate doc structure in `quarto.yml` file

3209efaba97b610cef3f06468208363b13388cde authored 8 months ago by Richie <[email protected]>

add: test_files

f615ab4de2863e24ca1568accad19c83aa410bfa authored 8 months ago by RealRichi3 <[email protected]>

Merge branch 'main' of https://github.com/Open-Science-Community-Saudi-Arabia/JSquarto into main

1d78efc64a53c3521692d4d41273476866114421 authored 8 months ago by RealRichi3 <[email protected]>

Merge pull request #9 from RealRichi3/dev

[12/02/2024] fix: syntaxError in for tsconfig.json

7e39ef7a8505c42be6406dff8970a35975278a3c authored 8 months ago by Batool Almarzouq <[email protected]>

fix: syntaxError in for tsconfig.json

This commit updates the npm script for starting up the project, it properly references the tscon...

cce5a9ec37e83eb764d8e81fbc2abb646c46bcaf authored 8 months ago by RealRichi3 <[email protected]>

fix: syntaxError in for tsconfig.json

This commit updates the npm script for starting up the project, it properly references the tscon...

9252b38da266ee5e44d04e95423664457bb551ae authored 8 months ago by RealRichi3 <[email protected]>

fix: wrong code construct name in generated doc

c939628b69f2c575beb2e41eb3e9272ed0405ef4 authored 8 months ago by RealRichi3 <[email protected]>

update README to include steps to preview docs

53cf20b1fdca8497497df53ff691f134a2443ff4 authored 8 months ago by RealRichi3 <[email protected]>

update comments and clean code

f030fdd9c0b1e9c7c1bc34cca322a5703c262d30 authored 8 months ago by RealRichi3 <[email protected]>

feat: generateQuartoYML file

dd812e21f2c54ea158166f15f49bef829ef4af05 authored 8 months ago by RealRichi3 <[email protected]>

add: command to generate and preview docs

eb6885720dabefac00e43ff217f2e7b2163dd640 authored 8 months ago by RealRichi3 <[email protected]>

add: constant for default quarto yaml config

6dfe486c4faaeac0f094a7de82264af76c180cd1 authored 8 months ago by RealRichi3 <[email protected]>

feat: generate quarto.yml file

48ccbbcab2eca944d1b47fe9b291404d8998a1f6 authored 8 months ago by RealRichi3 <[email protected]>

fix: all modules being categorized under default

Modules should be grouped by the category or subcategory they belong to, for the modules without...

ef336000bdc14c486d252020475019044035eb70 authored 8 months ago by RealRichi3 <[email protected]>

clean code

bad38eea1ad2b7ff802cac0eb816d6cf4c201f52 authored 8 months ago by RealRichi3 <[email protected]>

add: logger util

ba9e9341cefe01d7c3d27ec587e4972a1c7d8876 authored 8 months ago by RealRichi3 <[email protected]>

feat: writeDocsFromCategoriesToFile

This allow me to write the all the docs within a category to their respective qmd file

9bbb6e2522ffe28988b132f7a965c974b94c88dc authored 8 months ago by RealRichi3 <[email protected]>

Ecosyste.ms: OpenCollective

github.com/Open-Science-Community-Saudi-Arabia/JSquarto