Skip to content

Commit

Permalink
MDL-61460 tool_componentlibrary: Documentation for Moodle UI components
Browse files Browse the repository at this point in the history
- This tool is only available for admins
- Before using this tool the hosting admin will need to have NPM installed and be able to run grunt
- To create the docs pages for the library run "grunt componentlibrary"
- After the pages are created the Library is available in Site adminstration > Development > UI Component Library
  • Loading branch information
Bas Brands authored and abgreeve committed Jul 8, 2021
1 parent fa07310 commit 3de68ad
Show file tree
Hide file tree
Showing 140 changed files with 9,501 additions and 2 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Expand Up @@ -51,3 +51,5 @@ moodle-plugin-ci.phar
.eslintignore
.stylelintignore
/jsdoc
/admin/tool/componentlibrary/docs
/admin/tool/componentlibrary/hugo/site/data/my-index.json
3 changes: 3 additions & 0 deletions .grunt/tasks/componentlibrary.js
Expand Up @@ -129,6 +129,9 @@ module.exports = grunt => {
},
});

// Add the 'componentlibrary' task as a startup task.
grunt.moodleEnv.startupTasks.push('componentlibrary');

return {
docsBuild,
cssBuild,
Expand Down
1 change: 1 addition & 0 deletions .grunt/tasks/ignorefiles.js
Expand Up @@ -50,6 +50,7 @@ module.exports = grunt => {
'theme/boost/style/moodle.css',
'theme/classic/style/moodle.css',
'jsdoc/styles/*.css',
'admin/tool/componentlibrary/hugo/dist/css/docs.css',
].concat(thirdPartyPaths);
grunt.file.write('.stylelintignore', stylelintIgnores.join('\n') + '\n');
};
Expand Down
2 changes: 2 additions & 0 deletions admin/tool/componentlibrary/amd/build/clipboardwrapper.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions admin/tool/componentlibrary/amd/build/jsrunner.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions admin/tool/componentlibrary/amd/build/jsrunner.min.js.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions admin/tool/componentlibrary/amd/build/loader.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions admin/tool/componentlibrary/amd/build/loader.min.js.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions admin/tool/componentlibrary/amd/build/lunr.min.js

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions admin/tool/componentlibrary/amd/build/lunr.min.js.map

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions admin/tool/componentlibrary/amd/build/mustache.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions admin/tool/componentlibrary/amd/build/mustache.min.js.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions admin/tool/componentlibrary/amd/build/search.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 3de68ad

Please sign in to comment.