Giter Site home page Giter Site logo

uikit-site's Introduction

uikit banner

UIkit

Discord Build jsdelivr

UIkit is a lightweight and modular front-end framework for developing fast and powerful web interfaces.


UIkit is an Open Source project developed by YOOtheme.

YOOtheme


Getting started

You have the following options to get UIkit:

  • Download the latest release with pre-built CSS and JS.
  • Install with npm to get all source files as they are available on GitHub: npm install uikit
  • Install with yarn to get all source files as they are available on GitHub: yarn add uikit
  • Install with pnpm to get all source files as they are available on GitHub: pnpm add uikit
  • Directly load UIkit from jsDelivr: https://www.jsdelivr.com/package/npm/uikit
  • Clone the repo to get all source files including build scripts: git clone [email protected]:uikit/uikit.git

Developers

To always have the latest development version of UIkit, even before a release, you may want to use npm or yarn with the dev tag.

Contributing

Finding bugs, sending pull requests or improving our docs - any contribution is welcome and highly appreciated. To get started, head over to our contribution guidelines. Thanks!

Versioning

UIkit is maintained by using the Semantic Versioning Specification (SemVer).

Browser Support

Firefox Safari Chrome Edge Opera
Latest ✔ Latest ✔ Latest ✔ Latest ✔ Latest ✔

Tested With
BrowserStack

Copyright and License

Copyright YOOtheme GmbH under the MIT license.

uikit-site's People

Contributors

aarongerig avatar annemoeller avatar bezgodov avatar darkless012 avatar dasdeck avatar dependabot[bot] avatar drmzio avatar dvelguru avatar floriandotpy avatar franziskaschulz avatar hannazn avatar hendrikbehncke avatar ilikerobots avatar janschoenherr avatar m-ahmadi avatar malte-christian avatar mattfletcher avatar mattmacneil avatar mediafigaro avatar michaelmaass avatar miljan-aleksic avatar mouniryounes avatar nmacmunn avatar saschadube avatar sergejsteinz avatar shur avatar steffans avatar tmsagarofficial avatar viocassel avatar zzseba78 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

uikit-site's Issues

Off-Canvas parity between docs and dist

UIkit version

3.0.0-beta.40

Browser

Reproduction Link

The off-canvas on the official documentation shows as white, however when using it from distribution is grey. As the docs is there to show off the components I don't believe they should be styled. There should be no difference between the official docs and what is seen when using the framework.

No 404 directory handling and dead Google link

If I Google uikit templates or uikit showcase, within the top 5 results, there is a link to https://getuikit.com slash showcase slash.

This route does not exist, but most importantly, the site does not spit a usable 404, so it's just a white page.

(I've obfuscated the full URL for fear that Google may index this page and further advertise the dead link, not sure if that even happens tbh; safe than sorry.).

How to run documentation on browser

Hi all,
This is not an issue. I just need to know how to run the local server to view docs on browser.
I have googled and read different blogs but none of them really help.

If someone has been able to run this documentation offline or locally: https://github.com/uikit/uikit-site, please help me find out how to do so.

Thanks !

running this site as it is online

Good work with Uikit so far, i love it. i have issues running the site on my pc without network. i may still be a newbie but i have ran npm install && npm run setup with no issues, but now how do i load my views, appreciate any response. i am so sorry just noticing the closed issues

Tiny typo : iframs instead of iframes.

In file uikit-site/docs/pages/cover.md :

# Cover

<p class="uk-text-lead">Expand images, videos or iframs to cover their entire container and place your own content on top.</p>

[Feature Request in Docs] Advanced webpack usage for custom styling

UIkit version

3.0.0-rc.4

What is Expected?

Ability to add custom themes and icons when using uikit and webpack from npm

What is actually happening?

I had to completely write my own build script and completely reorganize the base scss to load in a different order to get the correct mixins and overrides to occur and the order I used. I also had to go through and add !default in many places.

Seems to work if....

If you build from source using your build scripts right from src UIKit seesm very customizable, however using a system like webpack and pulling from npm into a node_modules folder it seems very complex.

Icons

For example, adding in custom icons, in the docs you say you have to put the icons in the custom/** folder, however we shouldn't be modifying the node_modules/uikit folder, especially checking that into source control. So, i had to completely create a custom build script to look elsewhere.

My new base.scss for order of scss operations

// 1. Local Global Variable Overrides (does not require !default suffix)
@import "pinewood/global-variables.scss";

// 2. Global Variables (which all had to be suffixed with !default - this is a copy of uikit/src/scss/components/variables.scss, pulled local so i can make modifications for my clients project instead of modifying the very ugly variables.scss)
@import "uikit/base/global-variables.scss";

// 3. Base Variables (these are all the component's base variables suffixed with !default - it is uikit/src/scss/components/_import.scss without the "variables.scss" import)
@import "Client/uikit/base/_import-variables.scss";

// 4. Theme Variables (any custom variables I have for my theme that don't deal with uikit at all)
@import "pinewood/_import-variables.scss";

// 5. Global Mixins
@import "Client/uikit/base/global-mixins.scss";

// 6. Base Mixins
@import "Client/uikit/base/_import-mixins.scss";

// 7. Theme Mixins

// 8. Local Mixin Overrides

// 9. Import UIkit components (relevant to my clients site)
@import "Client/uikit/components.scss";

The order is different for scss and mixins since with classes is it first in wins where mixins last in wins, and since your src has these in the same file it is hard to do custom changes to both without using the very ugly variables.scss.

Just my two cents and would really like to see some examples on how to do custom scss, custom mixins, and custom icons using the npm package and webpack. Your webpack example is very basic, you are even calling the dist/css from the node_modules folder. I have tried a couple times to get this to work but I always find myself having to pull the scss out of the node_modules directory through some process or manually to make it work for customization. I do realize I can just create a global "overrides" like the processed variables.scss file you have but it just seems very complex to work with.

It just seems like there has to be an easier way when using webpack.

Currently it seems like you would have to:

  • Add custom icons to a folder in src
  • install uikit from npm
  • Copy the icon files and any custom scss/css from there to the node_modules/uikit/custom
  • Run the entire UIKit build processes where the working directory is node_modules/uikit
  • Reference the dist folder in webpack

But hoping there is a better way

Is there a static version of Uikit docs?

By "static version" I mean without js. The site currently is a huge SPA. Even if I've built the docs locally, it's still hard to find anythig given that I can only visit the root url localhost/ and navigate further.

Documentation <title>

Documentation should update the <title> tag with the <h1> content
With multiple windows/tabs, it's practically untrackable

Cannot run uikit-site

After translated the uikit docs into Chinese,...
I cannot run it with "npm run setup"
ERROR information:
errors

Documentation Translate PT-BR

Hello Fellows!!

I restart to learn Ui Design and to get out of anothers Frameworks i'm trying to learn about this Great Work. So, I found a offline documentation and I started today (03/04) to translate to portuguese brazil, for my compreention.

If its of your interest please, send me a message, [email protected].

Best Regards!

Thanks.

UIkit version

3.0.0-beta.40

Request: Please add this Visual Studio Code extension for UIkit class completion to the docs.

On the introduction page you mention auto-completion at UIkit autocomplete for your editor
https://getuikit.com/docs/introduction#uikit-autocomplete-for-your-editor

Could you add the following extension for Visual Studio Code?
I'm using it for HTML and Handlebars files, in the HTML class attribute. And it is fast and efficient.
It parses and caches all CSS files in the current VSCode workspace. If new classes or new CSS files were added to the workspace, you can reparse and recache by clicking the lightning icon in the status bar. Or you can hit Ctrl+Shift+P and type command Cache CSS class definitions.

VSCode extension HTML CSS Class Completion : https://marketplace.visualstudio.com/items?itemName=Zignd.html-css-class-completion

Missing npm module rollup-plugin-replace

Looks like you forgot/removed module rollup-plugin-replace from "devDependencies" in package.json.
I had to install it manually to get around the error :

> [email protected] icons /home/BobbyBabes/dev/web/docs/uikit3/yootheme/uikit-docs/assets/uikit
> node build/icons

module.js:472
    throw err;
    ^

Error: Cannot find module 'rollup-plugin-replace'
npm ERR! Tell the author that this fails on your system:
npm ERR!     node build/icons

uikit-site v3. how to install on owner local or virtual hosting?

please, I've already spent an empty two days with node / npm / bower, please make a video tutorial on installing the local offline documentation of the site or give free access to the local archive copy of such a site. this is very useful for many, who are just starting to learn UIKit3.

or plase share copy of carrent working arhive site with documentation UIKIT3

** Create a Official UIkit Code Blocks Repository**

Since UIkit it´s getting better and better, maybe it´s a good idea to create a Code Blocks repository for uikit 3, like it was uikitplay, but official.
Maybe a section in the docs, ordered by categories, or a Official Codepen account for this matter.
So people have a place to publish, or check some code examples made by users, it´s a great way to learn, and to find solutions.
It should be "Self-regulating" by the users, so it doesn´t take the uikit team time, they have enought work already.

I can't start local site

0 info it worked if it ends with ok
1 verbose cli [ 'C:\Program Files\nodejs\node.exe',
1 verbose cli 'C:\Program Files\nodejs\node_modules\npm\bin\npm-cli.js',
1 verbose cli 'run',
1 verbose cli 'watch' ]
2 info using [email protected]
3 info using [email protected]
4 verbose stack Error: missing script: watch
4 verbose stack at run (C:\Program Files\nodejs\node_modules\npm\lib\run-script.js:151:19)
4 verbose stack at C:\Program Files\nodejs\node_modules\npm\lib\run-script.js:61:5
4 verbose stack at C:\Program Files\nodejs\node_modules\npm\node_modules\read-package-json\read-json.js:115:5
4 verbose stack at C:\Program Files\nodejs\node_modules\npm\node_modules\read-package-json\read-json.js:402:5
4 verbose stack at checkBinReferences_ (C:\Program Files\nodejs\node_modules\npm\node_modules\read-package-json\read-json.js:357:45)
4 verbose stack at final (C:\Program Files\nodejs\node_modules\npm\node_modules\read-package-json\read-json.js:400:3)
4 verbose stack at then (C:\Program Files\nodejs\node_modules\npm\node_modules\read-package-json\read-json.js:160:5)
4 verbose stack at C:\Program Files\nodejs\node_modules\npm\node_modules\read-package-json\read-json.js:348:12
4 verbose stack at C:\Program Files\nodejs\node_modules\npm\node_modules\graceful-fs\graceful-fs.js:78:16
4 verbose stack at FSReqWrap.readFileAfterClose [as oncomplete] (fs.js:511:3)
5 verbose cwd C:\dev\uikit-site
6 verbose Windows_NT 10.0.16299
7 verbose argv "C:\Program Files\nodejs\node.exe" "C:\Program Files\nodejs\node_modules\npm\bin\npm-cli.js" "run" "watch"
8 verbose node v8.9.3
9 verbose npm v5.5.1
10 error missing script: watch
11 verbose exit [ 1, true ]

Docs should link to test pages

The new 3.0 docs don't have a link to the tests in the navbar, but the tests are a pretty good high-density way of viewing the capabilities of UIkit.

To give more visibility to the tests, it would be great if the tests could be linked to directly from the docs navbar, and/or if each section in the docs could link to the relevant section in the tests. One example where there is a cross-link is https://getuikit.com/assets/uikit/tests/index.html .

Error - npm run setup : bower uikit#^3.0.0 ENORESTARGET No tag found that was able to satisfy ^3.0.0

npm run setup returns error bower uikit#^3.0.0 ENORESTARGET No tag found that was able to satisfy ^3.0.0

What's up?
(I'm installing this on a virgin Linux installation.)

[BobbyBabes@LadyLuck scripts]# cd ~/dev/web/docs/uikit3/yootheme/uikit-docs
[BobbyBabes@LadyLuck uikit-docs]# npm run setup

> @ setup /home/BobbyBabes/dev/web/docs/uikit3/yootheme/uikit-docs
> npm install && bower update && npm run compile

npm WARN optional SKIPPING OPTIONAL DEPENDENCY: fsevents@^1.0.0 (node_modules/chokidar/node_modules/fsevents):
npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for [email protected]: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
npm WARN [email protected] requires a peer of css-loader@* but none was installed.
npm WARN uikit-docs No repository field.
npm WARN uikit-docs No license field.
bower uikit#^3.0.0          not-cached https://github.com/uikit/uikit.git#^3.0.0
bower uikit#^3.0.0             resolve https://github.com/uikit/uikit.git#^3.0.0
bower highlightjs#^9.4.0        cached https://github.com/components/highlightjs.git#9.9.0
bower highlightjs#^9.4.0      validate 9.9.0 against https://github.com/components/highlightjs.git#^9.4.0
bower uikit#^3.0.0        ENORESTARGET No tag found that was able to satisfy ^3.0.0

Additional error details:
Available versions in https://github.com/uikit/uikit.git: 3.0.0-beta.9, 3.0.0-beta.8, 3.0.0-beta.7, 3.0.0-beta.6, 3.0.0-beta.5, 3.0.0-beta.4, 3.0.0-beta.3, 3.0.0-beta.2, 3.0.0-beta.1, 2.27.2, 2.27.2, 2.27.1, 2.27.1, 2.27.0, 2.27.0, 2.26.4, 2.26.4, 2.26.3, 2.26.3, 2.26.2, 2.26.2, 2.26.1, 2.26.1, 2.26.0, 2.26.0, 2.25.0, 2.25.0, 2.24.3, 2.24.3, 2.24.2, 2.24.2, 2.24.1, 2.24.1, 2.24.0, 2.24.0, 2.23.0, 2.23.0, 2.22.0, 2.22.0, 2.21.0, 2.21.0, 2.20.3, 2.20.3, 2.20.2, 2.20.2, 2.20.1, 2.20.1, 2.20.0, 2.20.0, 2.19.0, 2.19.0, 2.18.0, 2.18.0, 2.17.0, 2.17.0, 2.16.2, 2.16.2, 2.16.1, 2.16.1, 2.16.0, 2.16.0, 2.15.0, 2.15.0, 2.14.0, 2.14.0, 2.13.1, 2.13.1, 2.13.0, 2.13.0, 2.12.0, 2.12.0, 2.11.1, 2.11.1, 2.11.0, 2.11.0, 2.10.0, 2.9.0, 2.8.0, 2.7.1, 2.7.0, 2.6.0, 2.5.0, 2.4.0, 2.3.1, 2.3.0, 2.2.0, 2.1.0, 2.0.0, 1.2.1, 1.2.0, 1.1.0, 1.0.2, 1.0.1, 1.0.0

npm ERR! Linux 4.9.7-1-ARCH
npm ERR! argv "/usr/bin/node" "/usr/sbin/npm" "run" "setup"
npm ERR! node v7.5.0
npm ERR! npm  v4.1.2
npm ERR! code ELIFECYCLE
npm ERR! @ setup: `npm install && bower update && npm run compile`
npm ERR! Exit status 1
npm ERR! 
npm ERR! Failed at the @ setup script 'npm install && bower update && npm run compile'.
npm ERR! Make sure you have the latest version of node.js and npm installed.
npm ERR! If you do, this is most likely a problem with the  package,
npm ERR! not with npm itself.
npm ERR! Tell the author that this fails on your system:
npm ERR!     npm install && bower update && npm run compile
npm ERR! You can get information on how to open an issue for this project with:
npm ERR!     npm bugs 
npm ERR! Or if that isn't available, you can get their info via:
npm ERR!     npm owner ls 
npm ERR! There is likely additional logging output above.

npm ERR! Please include the following file with any support request:
npm ERR!     /home/BobbyBabes/dev/web/docs/uikit3/yootheme/uikit-docs/npm-debug.log
[BobbyBabes@LadyLuck uikit-docs]# 

UPDATE:
And, as per the message above, the contents of /home/BobbyBabes/dev/web/docs/uikit3/yootheme/uikit-docs/npm-debug.log :

0 info it worked if it ends with ok
1 verbose cli [ '/usr/bin/node', '/usr/sbin/npm', 'run', 'setup' ]
2 info using [email protected]
3 info using [email protected]
4 verbose run-script [ 'presetup', 'setup', 'postsetup' ]
5 info lifecycle @~presetup: @
6 silly lifecycle @~presetup: no script for presetup, continuing
7 info lifecycle @~setup: @
8 verbose lifecycle @~setup: unsafe-perm in lifecycle true
9 verbose lifecycle @~setup: PATH: /usr/lib/node_modules/npm/bin/node-gyp-bin:/home/BobbyBabes/dev/web/docs/uikit3/yootheme/uikit-docs/node_modules/.bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin
10 verbose lifecycle @~setup: CWD: /home/BobbyBabes/dev/web/docs/uikit3/yootheme/uikit-docs
11 silly lifecycle @~setup: Args: [ '-c', 'npm install && bower update && npm run compile' ]
12 silly lifecycle @~setup: Returned: code: 1  signal: null
13 info lifecycle @~setup: Failed to exec setup script
14 verbose stack Error: @ setup: `npm install && bower update && npm run compile`
14 verbose stack Exit status 1
14 verbose stack     at EventEmitter.<anonymous> (/usr/lib/node_modules/npm/lib/utils/lifecycle.js:279:16)
14 verbose stack     at emitTwo (events.js:106:13)
14 verbose stack     at EventEmitter.emit (events.js:192:7)
14 verbose stack     at ChildProcess.<anonymous> (/usr/lib/node_modules/npm/lib/utils/spawn.js:40:14)
14 verbose stack     at emitTwo (events.js:106:13)
14 verbose stack     at ChildProcess.emit (events.js:192:7)
14 verbose stack     at maybeClose (internal/child_process.js:890:16)
14 verbose stack     at Process.ChildProcess._handle.onexit (internal/child_process.js:226:5)
15 verbose pkgid @
16 verbose cwd /home/BobbyBabes/dev/web/docs/uikit3/yootheme/uikit-docs
17 error Linux 4.9.7-1-ARCH
18 error argv "/usr/bin/node" "/usr/sbin/npm" "run" "setup"
19 error node v7.5.0
20 error npm  v4.1.2
21 error code ELIFECYCLE
22 error @ setup: `npm install && bower update && npm run compile`
22 error Exit status 1
23 error Failed at the @ setup script 'npm install && bower update && npm run compile'.
23 error Make sure you have the latest version of node.js and npm installed.
23 error If you do, this is most likely a problem with the  package,
23 error not with npm itself.
23 error Tell the author that this fails on your system:
23 error     npm install && bower update && npm run compile
23 error You can get information on how to open an issue for this project with:
23 error     npm bugs
23 error Or if that isn't available, you can get their info via:
23 error     npm owner ls
23 error There is likely additional logging output above.
24 verbose exit [ 1, true ]

How to remove box-shadow from card?

Referring to:

https://getuikit.com/docs/utility#box-shadow

And merging with the logic of:

.uk-padding-remove

I tried this:

.uk-box-shadow-remove

But that doesn't remove box shadow.

Box shadow is not defined in card.less:

I can remove it like this in my_theme.less, but not ideal:

// card box-shadow mixin - overrides card.less
.hook-card() { box-shadow: none !important; }

HTML

<div class="uk-width-1-3">
<div class="uk-card uk-card-secondary uk-card-body uk-light">1-3</div>
</div>

Using dash for component options in html and camelCase for component options in js can be unclear for new users

In the programmatic use section it mentions camelCase needs to be used for components made in js:
https://getuikit.com/docs/javascript#programmatic-use

This note can be easy to overlook for new users, who might try to use the option with a dash in it, as these are listed in all the component docs pages.

I'm not sure on the best solution, maybe there is an easy way to make the components use the dash options when initialized with js? If not maybe the docs could be more clear.

themes.json fetched with synchronous request

The JS console in Chrome gives this warning on the test pages site:

test.js:16 Synchronous XMLHttpRequest on the main thread is deprecated because of its detrimental effects to the end user's experience. For more help, check https://xhr.spec.whatwg.org/.

The line is:

request.open('GET', '../themes.json', false);

(Not a big deal, but I figured I would report it..)

Cannot use

Could you tell me how can I make uikit website work easily on win10? Thank you!

Tiny typo : "<aufio>" instead of "<audio>".

In file uikit-site/docs/pages/utility.md :

## Responsive objects

In UIkit `<img>`, `<canvas>`, `<aufio>` and `<video>` elements adapt to the width of their parent container by default. To apply responsive behavior to iframes, add the `uk-responsive` attribute . For other element or to apply a different behavior, just add one of the following classes.

Add LICENSE file to uikit-site

First off, thank you all for such an awesome project.

Secondly, I'm curious of what type of license is used for uikit-site. Is it the same MIT license as uikit?

The reason I'm asking is because we've chosen uikit as a framework and would like to provide our team members with a documentation site, but with the various style tweaks as requested by our design team. Specifically, we'd like to reuse your existing code example pages for components.

If we could add a LICENSE file so everyone is clear on what we can or cannot use that would be helpful.

Thanks!

Links are broken for both uikit-site-master and uikit-site-dev

I can run the repos from both branches, but all links are broken and/or I get 404s.

Tried editing package.json "compile-less" as per previous issue, but to no avail:
"compile-less": "mkdir css && lessc less/theme.less > css/theme.css --relative-urls --rootpath=../less/ -x"

Am I missing something? Thanks for any pointers.

Documentation - Toggle

First # Usage sample not working.

two elements with same id in html.

<p id="toggle">What's up?</p>

<h1 class="uk-h1 tm-heading-fragment" id="toggle" aria-hidden="false"><a href="#toggle">Toggle</a></h1>

Windows install fails (mkdir -p issue)

"npm run setup" fails on Windows.
In package.json, "mkdir -p css" is used to create the css folder.
The -p option does not work on windows.
It seams to be a common issue that could be solved with the "mkdirp" module:
primus/primus#382

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.