Skip to content

Latest commit

 

History

History
95 lines (71 loc) · 2.32 KB

README.md

File metadata and controls

95 lines (71 loc) · 2.32 KB

runelite.net CI

Based on redux-boot.

Local development

Requirements

First, you need to install all dependencies, so run

npm install

To start local server, simply run

npm start

from console. Your app should be now running on http://localhost:3000 and you will be able to see it from your web browser. To debug Redux actions, simply check your web console.

Creating blog posts

To create blog post, navigate to _posts directory. Here, create file with format (where the time is UTC timezone)

YYYY-MM-DD-HH-mm-My-Post-Title.md

and edit it in your favorite markdown editor. Content of each post should consist of:

+ ---
+ title: 'My Post Title'
+ description: 'My Post description'
+ author: 'Me'
+ ---
+
+ ... rest of markdown content

If you do not want to display your post on home page just add skip metadata:

  ---
  title: 'My Post Title'
  description: 'My Post description'
  author: 'Me'
+ skip: true
  ---

  ... rest of markdown content

Now save it and create PR to master branch on this repo.

Adding features

To add new feature to feature list, simply take an image and put it in features directory. Then, open features.js file and add your feature at the bottom, before ]

  {
    image: '/img/features/mousehighlight.png',
    title: 'Mouse highlighting',
    description: '...',
    link: '...'
- }
+ },
+ {
+   image: '/img/features/my_feature.png',
+   title: 'My Feature Name',
+   description: 'My feature description',
+   link: 'https://example.com'
+ }
]

Now save the file and create PR to master branch on this repo.

Publishing to GitHub pages

The deployment to GitHub pages is done automatically using Travis CI GitHub pages deployement and it is deployed to the gh-pages branch from master branch.