From d526db94ac59a7c8c0e9d0f440689d1eccb683c6 Mon Sep 17 00:00:00 2001 From: Alexander Heimbuch Date: Sat, 15 Jul 2017 08:38:38 +0200 Subject: [PATCH] fix(header): Enable truncation for title, subtile and description - Update docs system - Add references to old docs --- CONTRIBUTION.md | 27 ++----------- circle.yml | 1 + docs/Gemfile | 2 +- docs/Gemfile.lock | 4 +- docs/embedding.md | 2 +- docs/index.md | 7 +++- docs/persistence.md | 2 +- docs/playground.md | 4 +- package.json | 2 +- src/components/header/Info.vue | 27 ++++++++++--- src/components/icons/AudioIcon.vue | 62 +++++++++++++++--------------- 11 files changed, 69 insertions(+), 71 deletions(-) diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md index 62a086020..3aaa02a50 100644 --- a/CONTRIBUTION.md +++ b/CONTRIBUTION.md @@ -95,32 +95,11 @@ from the main (upstream) repository: git pull --ff upstream master ``` -## Coding Rules - -To ensure consistency throughout the source code, keep these rules in mind as you are working: - -* All features or bug fixes **must be tested** by one or more [specs][unit-testing]. -* All public API methods **must be documented** with ngdoc, an extended version of jsdoc (we added - support for markdown and templating via @ngdoc tag). To see how we document our APIs, please check - out the existing source code and see [this wiki page][ngDocs]. -* With the exceptions listed below, we follow the rules contained in - [Google's JavaScript Style Guide][js-style-guide]: - * **Do not use namespaces**: Instead, wrap the entire AngularJS code base in an anonymous closure and - export our API explicitly rather than implicitly. - * Wrap all code at **100 characters**. - * Instead of complex inheritance hierarchies, we **prefer simple objects**. We use prototypal - inheritance only when absolutely necessary. - * We **love functions and closures** and, whenever possible, prefer them over objects. - * To write concise code that can be better minified, we **use aliases internally** that map to the - external API. See our existing code to see what we mean. - * We **don't go crazy with type annotations** for private internal APIs unless it's an internal API - that is used throughout AngularJS. The best guidance is to do what makes the most sense. - ## Git Commit Guidelines We have very precise rules over how our git commit messages can be formatted. This leads to **more readable messages** that are easy to follow when looking through the **project history**. But also, -we use the git commit messages to **generate the AngularJS change log**. +we use the git commit messages to **generate the change log**. The commit message formatting can be added using a typical git workflow or through the use of a CLI wizard ([Commitizen](https://github.com/commitizen/cz-cli)). To use the wizard, run `yarn commit` @@ -162,8 +141,8 @@ Must be one of the following: generation ### Scope -The scope could be anything specifying place of the commit change. For example `$location`, -`$browser`, `$compile`, `$rootScope`, `ngHref`, `ngClick`, `ngView`, etc... +The scope could be anything specifying place of the commit change. For example `progress`, +`chapters`, `settings`, `tabs`, etc... You can use `*` when the change affects more than a single scope. diff --git a/circle.yml b/circle.yml index 18ead5118..0644974eb 100644 --- a/circle.yml +++ b/circle.yml @@ -47,6 +47,7 @@ deployment: - yarn deploy:gh-pages release: + branch: master tag: /v.*/ commands: - yarn dist:clean diff --git a/docs/Gemfile b/docs/Gemfile index 014f6eb12..f724ca636 100644 --- a/docs/Gemfile +++ b/docs/Gemfile @@ -11,7 +11,7 @@ source "https://rubygems.org" gem "jekyll", "3.5.0" # This is the default theme for new Jekyll sites. You may change this to anything you like. -gem "millidocs", "~> 0.2.2" +gem "millidocs", "~> 0.2.3" # If you want to use GitHub Pages, remove the "gem "jekyll"" above and # uncomment the line below. To upgrade, run `bundle update github-pages`. diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock index 72cfee16d..047d35a70 100644 --- a/docs/Gemfile.lock +++ b/docs/Gemfile.lock @@ -27,7 +27,7 @@ GEM rb-fsevent (~> 0.9, >= 0.9.4) rb-inotify (~> 0.9, >= 0.9.7) mercenary (0.3.6) - millidocs (0.2.2) + millidocs (0.2.3) jekyll (~> 3.4) pathutil (0.14.0) forwardable-extended (~> 2.6) @@ -44,7 +44,7 @@ PLATFORMS DEPENDENCIES jekyll (= 3.5.0) - millidocs (~> 0.2.2) + millidocs (~> 0.2.3) BUNDLED WITH 1.15.1 diff --git a/docs/embedding.md b/docs/embedding.md index aee1d3407..dec76ab86 100644 --- a/docs/embedding.md +++ b/docs/embedding.md @@ -6,7 +6,7 @@ navigation: 2 # Embedding -
+

@@ -18,7 +18,7 @@ navigation: 7 summary: 'Wir haben eine wie wir finden abwechslungsreiche Sendung produziert, die wir Euch wie immer mit Freude bereitstellen. Während die Live-Hörer Freak-Show-Bingo spielen, greifen wir das Wikipedia-Thema der letzten Sendung auf und liefern auch noch weitere Aspekte des optimalen Star-Wars-Medienkonsums frei Haus. Dazu viel Nerderei rund um die Kommandozeile, eine Einschätzung der Perspektive der Apple Watch, ein Rant über die mangelhafte Security im Internet of Things (and Buildings) und allerlei anderer Kram. Roddi setzt dieses Mal aus, sonst Vollbesetzung.', publicationDate: '2016-02-11T03:13:55+00:00', poster: 'https://freakshow.fm/wp-content/cache/podlove/04/662a9d4edcf77ea2abe3c74681f509/freak-show_200x200.jpg', - link: 'https://freakshow.fm/fs171-invasion' + link: 'https://freakshow.fm/fs171-invasion', show: { title: 'Freak Show', subtitle: 'Menschen! Technik! Sensationen!', diff --git a/package.json b/package.json index f518d4a5d..3d6da1421 100644 --- a/package.json +++ b/package.json @@ -29,7 +29,7 @@ "postinstall": "cd docs && bundle install", "docs:dev": "jekyll build --source docs --destination dist && cp -R docs/fixtures/* dist/fixtures", "docs:prod": "jekyll build --source docs --destination dist --config docs/_config_prd.yml && cp -R docs/fixtures/* dist/fixtures", - "webpack:dev": "webpack-dashboard -- webpack-dev-server --content-base dist/ --progress --hot --inline --config src/webpack.config.js --host 192.168.178.42", + "webpack:dev": "webpack-dashboard -- webpack-dev-server --content-base dist/ --progress --hot --inline --config src/webpack.config.js", "webpack:build": "NODE_ENV='production' webpack --config src/webpack.config.js", "build": "npm run webpack:build", "dev": "npm run dist:clean && npm run docs:dev && npm run webpack:dev", diff --git a/src/components/header/Info.vue b/src/components/header/Info.vue index 275dbadb5..67742847c 100644 --- a/src/components/header/Info.vue +++ b/src/components/header/Info.vue @@ -6,13 +6,13 @@
-

- {{show.title}} - {{show.title}} +

+ {{show.title}} + {{show.title}}

-

- {{episode.title}} - {{episode.title}} +

+ {{episode.title}} + {{episode.title}}

{{episode.subtitle}}
@@ -78,6 +78,10 @@ margin-bottom: $margin / 3; font-weight: inherit; font-size: 1.8em; + + a, span { + display: block; + } } .show-title { @@ -85,6 +89,17 @@ font-weight: inherit; font-size: 1em; line-height: 1.2em; + min-width: 0; + + a, span { + display: block; + } + } + + .description { + width: 100%; + max-width: 100%; + overflow: hidden; } .subtitle { diff --git a/src/components/icons/AudioIcon.vue b/src/components/icons/AudioIcon.vue index 948b9c1db..62c1e89f0 100644 --- a/src/components/icons/AudioIcon.vue +++ b/src/components/icons/AudioIcon.vue @@ -1,40 +1,38 @@