Skip to content
This repository was archived by the owner on Feb 10, 2024. It is now read-only.

Commit fc3875a

Browse files
authored
Added details of Rouge CSS to README
1 parent ef26ab5 commit fc3875a

1 file changed

Lines changed: 18 additions & 5 deletions

File tree

README.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
1-
# Lordcodes Syntax - A code colour theme 🖍 ⌨️
1+
# Lord Codes Syntax - A code colour theme 🖍 ⌨️
22

33
Here I store the code theme I use in a variety of formats.
44

5-
1. Android Studio / IntelliJ
6-
2. Xcode
5+
1. [Android Studio / IntelliJ](https://github.com/lordcodes/lordcodes-syntax-theme#android-studio--intellij-)
6+
2. [Xcode](https://github.com/lordcodes/lordcodes-syntax-theme#xcode-)
7+
3. [Web - Rouge CSS](https://github.com/lordcodes/lordcodes-syntax-theme#web---rouge-css)
78

89
The theme is designed for 'dark' interfaces, starting from the base of the default dark themes for each tool. Each colour was chosen to have an appropriate level of constrast for accessibility and readability.
910

@@ -27,7 +28,7 @@ Optimised for Kotlin and Java, but colours also provided for other syntax types.
2728

2829
The repository contains both 'LordCodes Syntax.icls' and 'LordCodes Syntax.jar'.
2930

30-
1. Clone this repo or download it as a Zip.
31+
1. Clone this repository or download it as a zip.
3132
```
3233
$ git clone https://github.com/lordcodes/lordcodes-syntax-theme.git
3334
```
@@ -44,7 +45,7 @@ Primarily optimised for Swift, but should also apply in same way to Obj-C.
4445

4546
### Usage
4647

47-
1. Clone this repo or download it as a Zip.
48+
1. Clone this repository or download it as a zip.
4849
```
4950
$ git clone https://github.com/lordcodes/lordcodes-syntax-theme.git
5051
```
@@ -54,6 +55,18 @@ $ git clone https://github.com/lordcodes/lordcodes-syntax-theme.git
5455
```
5556
3. Copy the file `xcode/LordCodes-Syntax.xccolortheme` into the folder.
5657

58+
## Web - Rouge CSS
59+
60+
Includes the SASS files for applying the syntax theme on web, using the [Rouge syntax highlighter](https://github.com/jneen/rouge). Rouge is commonly used with the Jekyll static site generator, which is where the theme has been tested.
61+
62+
### Usage
63+
64+
1. Clone this repository or download it as a zip.
65+
```
66+
$ git clone https://github.com/lordcodes/lordcodes-syntax-theme.git
67+
```
68+
2. Copy and paste the files from `web-rouge` to your project's SASS location.
69+
5770
## Attribution
5871

5972
Inspiration was taken from many sources when putting the theme together. This included how to constrast pairs of colours, ideas for colours to go with for certain parts of syntax to specific colours selected for the theme. There may be other areas of indirect inspiration as well! If you recognise anything in my theme from something of yours, please reach me on [Twitter](https://twitter.com/lordcodes) and I will add you below.

0 commit comments

Comments
 (0)