-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
19 changed files
with
7,353 additions
and
486 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| {"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"spork-css documentation spork-css is a simple and lighweight css framework that is customizable and extendable. This is a work in progress and not a fully fledged framework. About The name of this project is based on a repo name randomy generated by Github called \"Glowing Spork\", and is a play on the words Spoon and Fork. The aim of this library is to primarily learn building a css library based on scss, and publshing as a resuable package on npm. Installation Run the below command from your project root directory (where package.json is present) to add the library to your project. npm i spork-css Usage Import and include the spork scss file into your scss file. Then use the generated css file into your html project. See the test/ folder in the repo for reference. // Import the library @import '~/spork-css'; Advanced Usage // Override any theme variables here // Import the library @import '~/spork-css'; Variables See the Customize page","title":"HOME"},{"location":"#spork-css-documentation","text":"spork-css is a simple and lighweight css framework that is customizable and extendable. This is a work in progress and not a fully fledged framework.","title":"spork-css documentation"},{"location":"#about","text":"The name of this project is based on a repo name randomy generated by Github called \"Glowing Spork\", and is a play on the words Spoon and Fork. The aim of this library is to primarily learn building a css library based on scss, and publshing as a resuable package on npm.","title":"About"},{"location":"#installation","text":"Run the below command from your project root directory (where package.json is present) to add the library to your project. npm i spork-css","title":"Installation"},{"location":"#usage","text":"Import and include the spork scss file into your scss file. Then use the generated css file into your html project. See the test/ folder in the repo for reference. // Import the library @import '~/spork-css';","title":"Usage"},{"location":"#advanced-usage","text":"// Override any theme variables here // Import the library @import '~/spork-css';","title":"Advanced Usage"},{"location":"#variables","text":"See the Customize page","title":"Variables"},{"location":"components/","text":"Components The following components are part of the library as of now, with more in progress. Badge Button Card Navbar","title":"COMPONENTS"},{"location":"components/#components","text":"The following components are part of the library as of now, with more in progress.","title":"Components"},{"location":"components/#badge","text":"","title":"Badge"},{"location":"components/#button","text":"","title":"Button"},{"location":"components/#card","text":"","title":"Card"},{"location":"components/#navbar","text":"","title":"Navbar"},{"location":"customize/","text":"Customize spork-css Spork CSS is a modularized library, where either the entire library can be included or base plus components. Colors Variable Name Description Default Color $primary Primary Theme Color #3299ef $secondary Secondary Theme Color #1ac888 $error Error Color #d32752 $info Info Color #f6c31c $main-bg-color Body background Color #3299ef $main-text-color Body Text Color #3299ef Sizes Variable Name Description $base-padding Default Padding $base-border-thickness Default border Thickness","title":"CUSTOMIZE"},{"location":"customize/#customize-spork-css","text":"Spork CSS is a modularized library, where either the entire library can be included or base plus components.","title":"Customize spork-css"},{"location":"customize/#colors","text":"Variable Name Description Default Color $primary Primary Theme Color #3299ef $secondary Secondary Theme Color #1ac888 $error Error Color #d32752 $info Info Color #f6c31c $main-bg-color Body background Color #3299ef $main-text-color Body Text Color #3299ef","title":"Colors"},{"location":"customize/#sizes","text":"Variable Name Description $base-padding Default Padding $base-border-thickness Default border Thickness","title":"Sizes"},{"location":"license/","text":"ISC License Copyright 2023 AeAppLabs Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.","title":"LICENSE"},{"location":"license/#isc-license","text":"Copyright 2023 AeAppLabs Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.","title":"ISC License"},{"location":"release_notes/","text":"Release Notes v0.1.6 (Dec 21, 2023) Update Documentation Update Badge component v0.1.5 (Dec 21, 2023) Update Documentation, fixes #1 v0.1.4 (Apr 21, 2023) Update Documentation v0.1.3 (Apr 21, 2023) cleanup and reorganizing Publish to npm repository Added logo and meta data Published to https://www.npmjs.com/package/spork-css v0.0.1 (Sep 20, 2021) Initial commit","title":"RELEASE NOTES"},{"location":"release_notes/#release-notes","text":"","title":"Release Notes"},{"location":"release_notes/#v016-dec-21-2023","text":"Update Documentation Update Badge component","title":"v0.1.6 (Dec 21, 2023)"},{"location":"release_notes/#v015-dec-21-2023","text":"Update Documentation, fixes #1","title":"v0.1.5 (Dec 21, 2023)"},{"location":"release_notes/#v014-apr-21-2023","text":"Update Documentation","title":"v0.1.4 (Apr 21, 2023)"},{"location":"release_notes/#v013-apr-21-2023","text":"cleanup and reorganizing Publish to npm repository Added logo and meta data Published to https://www.npmjs.com/package/spork-css","title":"v0.1.3 (Apr 21, 2023)"},{"location":"release_notes/#v001-sep-20-2021","text":"Initial commit","title":"v0.0.1 (Sep 20, 2021)"}]} | ||
| {"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"spork-css documentation spork-css is a simple and lighweight css framework that is customizable and extendable. This is a work in progress and not a fully fledged framework. About The name of this project is based on a repo name randomy generated by Github called \"Glowing Spork\", and is a play on the words Spoon and Fork. The aim of this library is to primarily learn building a css library based on scss, and publshing as a resuable package on npm. Installation Run the below command from your project root directory (where package.json is present) to add the library to your project. npm i spork-css Usage Import and include the spork scss file into your scss file. Then use the generated css file into your html project. See the test/ folder in the repo for reference. // Import the library @import '~/spork-css'; Advanced Usage // Override any theme variables here // Import the library @import '~/spork-css'; Variables See the Customize page","title":"HOME"},{"location":"#spork-css-documentation","text":"spork-css is a simple and lighweight css framework that is customizable and extendable. This is a work in progress and not a fully fledged framework.","title":"spork-css documentation"},{"location":"#about","text":"The name of this project is based on a repo name randomy generated by Github called \"Glowing Spork\", and is a play on the words Spoon and Fork. The aim of this library is to primarily learn building a css library based on scss, and publshing as a resuable package on npm.","title":"About"},{"location":"#installation","text":"Run the below command from your project root directory (where package.json is present) to add the library to your project. npm i spork-css","title":"Installation"},{"location":"#usage","text":"Import and include the spork scss file into your scss file. Then use the generated css file into your html project. See the test/ folder in the repo for reference. // Import the library @import '~/spork-css';","title":"Usage"},{"location":"#advanced-usage","text":"// Override any theme variables here // Import the library @import '~/spork-css';","title":"Advanced Usage"},{"location":"#variables","text":"See the Customize page","title":"Variables"},{"location":"components/","text":"Components The following components are part of the library as of now, with more in progress. Badge Button Card Navbar","title":"COMPONENTS"},{"location":"components/#components","text":"The following components are part of the library as of now, with more in progress.","title":"Components"},{"location":"components/#badge","text":"","title":"Badge"},{"location":"components/#button","text":"","title":"Button"},{"location":"components/#card","text":"","title":"Card"},{"location":"components/#navbar","text":"","title":"Navbar"},{"location":"customize/","text":"Customize spork-css Spork CSS is a modularized library, where either the entire library can be included or base plus components. Colors Variable Name Description Default Color $primary Primary Theme Color #3299ef $secondary Secondary Theme Color #1ac888 $error Error Color #d32752 $info Info Color #f6c31c $main-bg-color Body background Color #3299ef $main-text-color Body Text Color #3299ef Sizes Variable Name Description $base-padding Default Padding $base-border-thickness Default border Thickness","title":"CUSTOMIZE"},{"location":"customize/#customize-spork-css","text":"Spork CSS is a modularized library, where either the entire library can be included or base plus components.","title":"Customize spork-css"},{"location":"customize/#colors","text":"Variable Name Description Default Color $primary Primary Theme Color #3299ef $secondary Secondary Theme Color #1ac888 $error Error Color #d32752 $info Info Color #f6c31c $main-bg-color Body background Color #3299ef $main-text-color Body Text Color #3299ef","title":"Colors"},{"location":"customize/#sizes","text":"Variable Name Description $base-padding Default Padding $base-border-thickness Default border Thickness","title":"Sizes"},{"location":"license/","text":"ISC License Copyright 2023 AeAppLabs Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.","title":"LICENSE"},{"location":"license/#isc-license","text":"Copyright 2023 AeAppLabs Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.","title":"ISC License"},{"location":"release_notes/","text":"Release Notes v0.1.7 (Jan 08, 2024) Code Cleanup Additional reset styles Update test files v0.1.6 (Dec 21, 2023) Update Documentation Update Badge component v0.1.5 (Dec 21, 2023) Update Documentation, fixes #1 v0.1.4 (Apr 21, 2023) Update Documentation v0.1.3 (Apr 21, 2023) cleanup and reorganizing Publish to npm repository Added logo and meta data Published to https://www.npmjs.com/package/spork-css v0.0.1 (Sep 20, 2021) Initial commit","title":"RELEASE NOTES"},{"location":"release_notes/#release-notes","text":"","title":"Release Notes"},{"location":"release_notes/#v017-jan-08-2024","text":"Code Cleanup Additional reset styles Update test files","title":"v0.1.7 (Jan 08, 2024)"},{"location":"release_notes/#v016-dec-21-2023","text":"Update Documentation Update Badge component","title":"v0.1.6 (Dec 21, 2023)"},{"location":"release_notes/#v015-dec-21-2023","text":"Update Documentation, fixes #1","title":"v0.1.5 (Dec 21, 2023)"},{"location":"release_notes/#v014-apr-21-2023","text":"Update Documentation","title":"v0.1.4 (Apr 21, 2023)"},{"location":"release_notes/#v013-apr-21-2023","text":"cleanup and reorganizing Publish to npm repository Added logo and meta data Published to https://www.npmjs.com/package/spork-css","title":"v0.1.3 (Apr 21, 2023)"},{"location":"release_notes/#v001-sep-20-2021","text":"Initial commit","title":"v0.0.1 (Sep 20, 2021)"}]} |
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.