medium-clone

medium-clone copied to clipboard

=== Mediumm ===

Build Status

Mediumm - WordPress theme, very inspired by medium.com

Mediumm WordPress Theme, Copyright 2017 Nathachai Thongniran Mediumm is distributed under the terms of the GNU GPL

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/gpl-2.0.html.

Mediumm WordPress Theme is derived from Sage WordPress Theme, Copyright 2013 Ben Word and Scott Walkinshaw Sage WordPress Theme is distributed under the terms of the MIT

Mediumm WordPress Theme bundles the following third-party resources:

FastClick, Copyright 2014 The Financial Times Ltd FastClick is licensed under the terms of the MIT Source: https://github.com/ftlabs/fastclick

Font Awesome, Copyright 2012 Dave Gandy Font Awesome is licensed under the terms of the MIT Source: http://fontawesome.io/

Pace, 2013 HubSpot Pace.js is licensed under the terms of the MIT Source: https://github.com/HubSpot/pace/

Jeans Kit, Copyright 2016 Nathachai Thongniran Jeans Kit is licensed under the terms of the MIT Source: https://github.com/jojoee/jeans-kit

The image is used in screenshot, Gabriel Garcia Marengo The image is licensed under the terms of the CC0 1.0 Universal Source: https://unsplash.com/@gabrielgm

=== Getting started (step to) ===

= Build =

1. Install Node.js
2. Set path (e.g. cd wp-content/themes/medium-clone/)
3. Install global: npm install -g bower yarn
4. Install dependencies: yarn & bower install
5. Set proxy on devUrl in wp-content\themes\medium-clone\assets\manifest.json
6. Build theme: npm run build

= Develop =

1. Follow "Build"
2. Run task runner: npm run watch

= Submit theme =

1. Follow "Build"
2. Build: npm run build.prod
3. Check

• The directory have no uncommitted files
• Line endings, EOL conversion in notepad ++

4. Pack theme: npm run pack
5. Upload to wordpress.org/themes/upload/

=== Note ===

• Theme name: mediumm
• Text domain: mediumm
• PHP: 5.3.0+
• Breadcrumb: Yoast SEO over Breadcrumb NavXT
• Based: sage-with-space 8.4.2 but using package.json and gulpfile.js from 8.5.1
• CSS code style: rscss
• Javascript code style: Airbnb JavaScript Style Guide
• CSS grid: Bootstrap 3
• Space multiply: 6px
• Browser compatibility
  • Chrome
  • Firefox
  • IE 10+

=== Medium layout (changed) ===

• Header
  • [x] Logo (changed to site title)
  • [ ] Stick on top when scroll up
  • [ ] Hide on top when scroll down
  • [ ] Search icon
  • [ ] Menu (desktop), remove menu from the header except homepage
  • [ ] Menu (mobile)
• Content box
  • [ ] Featured image logic
  • [x] Number of responses (removed)
  • [x] Using category instead of tag
  • [ ] Tag style
  • [ ] Highlights feature
  • [ ] Lightbox
  • [x] Various width side: 660px on tag page, 640px author page, 740px on single post (changed to 720px, from Bootstrap grid system)
• Sidebar
  • [x] Stick when scroll (removed)
• Footer
  • [x] Load more when scroll (removed, display site url instead)
  • [x] Add 1 sidebar
• Page style
  • [ ] Post: author description on top / bottom, full-width featured image
  • [x] Archive: Category / Tag
  • [x] Archive: Author (author section on the top)
  • [ ] Search
• Misc
  • [ ] Improve page loading progression (now, using PACE)
  • [ ] Fix h1 tag on each post / page
  • [ ] Incomplete green circle of author thumbnail

=== Support ===

• [ ] WP-PageNavi
• [x] Contact Form 7
• [x] Really Simple CAPTCHA
• [x] Yoast SEO breadcrumb (page only) (over Breadcrumb NavXT)
• [x] Breadcrumb NavXT
• [ ] Yet Another Related Posts Plugin (YARPP)
• [ ] WordPress Popular Posts
• [ ] Facebook Comments
• [x] Jetpack by WordPress.com / Slim Jetpack Tiled Gallery
• [ ] Ninja Forms
• [ ] MailChimp for WordPress
• [ ] Disqus Comment System
• [ ] Page Builder by SiteOrigin
• [ ] SiteOrigin Widgets Bundle
• [ ] NextGEN Gallery
• [ ] WooCommerce and test with dummy woocommerce content
• [ ] bbPress
• [ ] BuddyPress
• [x] Customizer: custom body background color and image
• [x] Customizer: custom header color and header background image

=== Updates ===

• [ ] Demo website
• [ ] Lightbox: (e.g. MediumLightbox, Fluidbox, Magnific Popup)
• [x] Google Fonts: Web Font Loader
• [x] FastClick
• [x] Translation ready
• [ ] Upload to wordpress.org
• [ ] Remove gulp-clean and using del instead
• [ ] Fix .travis.yml

=== Changelog ===

= 1.1.5 =

• Refactor, namespace system
• Refactor, change code style (using PhpStorm default WordPress code style)
• Check PHP version on theme activation (theme can not activated, if running on PHP version below 5.3.0)

= 1.1.4 =

• Update readme.txt

= 1.1.3 =

• Remove jquery.js from distribution
• Beautify js distribution file
• Remove .map file from distribution
• Remove post-formats and add custom-background, custom-header, custom-menu tags
• Fixed, missing translation

= 1.1.2 =

• Using Web Font Loader from local instead of CDN
• Add condition into "excerpt_more" filter to make sure it will not affect admin side
• Using esc_url + home_url instead of get_home_url

= 1.1.1 =

• Fixed, show mobile menu even if we didn't select menu

= 1.1.0 =

• Support custom body background color and image
• Support custom header color and header background image
• Change text-domain from "medm" to "mediumm"
• Fixed, un-scale featured image width
• Fixed, fluid width Youtube video embeds (iframe) in content
• Fixed, article category tag overflow (listing page)
• Fixed, mobile menu centering
• Fixed, Jetpack tiled gallery
• Fixed, text beside image should be float (single post)
• Fixed, text overflow on article's content (single post)
• Fixed, text overflow on article's summary (listing page)

= 1.0.5 =

• Fixed, minor error on PHP below 5.4

= 1.0.4 =

• Change PHP array syntax to support PHP below 5.4

= 1.0.3 =

• Fixed, document

= 1.0.2 =

• Refactor
• Update and fix css
• Implement webfontloader

= 1.0.1 =

• Fixed, build system

= 1.0.0 =

• First release

=== Contribute ===

1. Setup WordPress server
2. Install Node.js
3. Install NPM related: npm install -g gulp bower yarn
4. Install PHP related (install phpcs and composer)
5. Install WordPress Coding Standards for PHP_CodeSniffer
6. Install dependencies: yarn && bower install && composer install
7. Test

• Manual test layout
• Build test: gulp without error
• PHP Code style: phpcs -p ./*.php --standard=ruleset.xml without error

=== Checklist (development purpose) ===

• [x] Theme unit test: wptest.io
• [x] Page - Home
• [x] Page - Archive: Category
• [x] Page - Archive: Tag
• [x] Page - Archive: Author
• [x] Page - Archive: Date
• [x] Page - Singular: Post
• [x] Page - Singular: Page
• [x] Page - Attachment
• [x] Page - Search
• [x] Page - 404
• [x] Component: Widget tested by Monster Widget
• [x] Component: Menu
• [x] Component: WordPress Comment
• [ ] Component: More tag (optional)
• [ ] Component: Paginated (optional)
• [ ] Component: Stick footer-info at the bottom e.g. 404 page (optional)
• [x] Component: Contact Form 7
• [x] Component: Really Simple CAPTCHA
• [x] Component: 3rd party breadcrumb by Yoast breadcrumbs and Breadcrumb NavXT
• [x] Vendor: Theme Check, checked
• [x] Vendor: Log Deprecated Notices, checked
• [x] Vendor: RTL Tester, checked
• [x] Vendor: Jetpack - Tiled Galleries
• [x] Screenshot
• [x] Customize

=== Contributor ===

• jojoee
• tlongren

=== Other versions ===

• [x] WordPress: jojoee/medium-clone
• [x] Html: jojoee/mediumm-template
• [x] React: jojoee/mediumm-react
• [ ] Hexo

Reference & Thank you

• Project template from Koa WordPress theme