Added article about syntax highlight with Pygments #51

Ze0nC · 2020-01-15T13:32:16Z

Hi. Thank you for making Publish.
I have made a plugin for syntax highlighting using Pygments, and added a How-to article about using the plugin.
I hope it will help a little bit to the project.
Here is an example on my site built with Publish:
https://czj.pw/highlight
Cheers,
Zhijin

JohnSundell

Thanks a lot for this @Ze0nC, and fantastic that you built a plugin for Pygments! I left a few comments inline, mainly I'd like this new document to be somewhat simplified, to make it easier for me to maintain. Let me know if you want any additional info.

JohnSundell · 2020-01-15T22:33:01Z

Documentation/HowTo/add-syntax-highlighting-with-pygments.md

+It is a Pygments plugin for [Publish](https://github.com/johnsundell/publish) to highlight code. 
+[Pygments](https://pygments.org) is a syntax highlighting tool made in Python that supports many languages. 
+
+## Requirements


Rather than putting instructions inline here, I'd prefer for this and the following "How to" section to simply reference your plugin's README. Otherwise, I'll have to make sure to keep this up to date as you change your implementation and requirements, which'll most likely result in this becoming out of date. Take a look at the Splash plugin's "How to" guide for example. I think this file should only contain step number 4, that is, how to insert your plugin into a publishing pipeline.

I have moved the detailed guide to plugin's README.md and simplified the How-to ariticle.

JohnSundell · 2020-01-15T22:35:07Z

Documentation/HowTo/add-syntax-highlighting-with-pygments.md

+```swift
+import SwiftPygmentsPublishPlugin
+...
+try DeliciousRecipes().publish(using: [


Please use a more generic website name here, like MyWebsite, since DeliciousRecipes only makes sense within the context of the README.

Thanks. I will change it.

JohnSundell · 2020-01-15T22:35:22Z

Documentation/README.md

@@ -11,5 +11,6 @@ Shorter articles focused on explaining how to get a given task done using Publis
 - [Adding Swift syntax highlighting to Markdown code blocks](HowTo/adding-swift-syntax-highlighting.md)
 - [Nesting items within folders](HowTo/nested-items.md)
 - [Using a custom `DateFormatter`](HowTo/using-a-custom-date-formatter.md)
+- [Add syntax highlighting with Pygments](HowTo/add-syntax-highlighting-with-pygments.md)


Should be "Adding" here.

Thanks. Change has been made.

Details are moved to plugin's readme.md

Ze0nC · 2020-01-16T06:16:47Z

I have made some change to the articles.
Please have a look if they are better now.
Cheers.

JohnSundell

Thanks @Ze0nC, it looks great now. Just a few grammar fixes + suggestions. Let me know if you don't have time to fix these and I can fix them post-merge, and let me know if I can provide any additional context.

JohnSundell · 2020-01-16T10:37:43Z

Documentation/HowTo/add-syntax-highlighting-with-pygments.md

@@ -0,0 +1,21 @@
+# How to add syntax highlighting with Pygments
+[Splash](https://github.com/JohnSundell/Splash) and its [official plugin](https://github.com/JohnSundell/SplashPublishPlugin) are great tools for highlighting swift syntax in Publish. 


"swift" -> "Swift"

"in Publish" -> "when using Publish"

JohnSundell · 2020-01-16T10:39:10Z

Documentation/HowTo/add-syntax-highlighting-with-pygments.md

+# How to add syntax highlighting with Pygments
+[Splash](https://github.com/JohnSundell/Splash) and its [official plugin](https://github.com/JohnSundell/SplashPublishPlugin) are great tools for highlighting swift syntax in Publish. 
+
+However, some people write not only in Swift, but also in many other languages. There comes the [SwiftPygmentsPublishPlugin](https://github.com/Ze0nC/SwiftPygmentsPublishPlugin) to help. 


Suggestion: "There comes the ... to help" -> "That's when ... can be really useful"

JohnSundell · 2020-01-16T10:39:33Z

Documentation/HowTo/add-syntax-highlighting-with-pygments.md

+
+However, some people write not only in Swift, but also in many other languages. There comes the [SwiftPygmentsPublishPlugin](https://github.com/Ze0nC/SwiftPygmentsPublishPlugin) to help. 
+
+Please follow the plugin's [installation guide](https://github.com/Ze0nC/SwiftPygmentsPublishPlugin#installation) to install pygments and add it to your website's Swift package, and then add it to publishing pipeline:


"pygments" -> "Pygments"

"and add it" -> "and to add it"
"to publishing pipeline" -> "to your publishing pipeline"

JohnSundell · 2020-01-16T10:40:49Z

Documentation/HowTo/add-syntax-highlighting-with-pygments.md

+])
+```
+
+Please refer to [usage guide](https://github.com/Ze0nC/SwiftPygmentsPublishPlugin#usage) to see how to specify syntax language and more. 


"refer to [" -> "refer to the ["

JohnSundell · 2020-01-16T10:44:16Z

Documentation/HowTo/add-syntax-highlighting-with-pygments.md

+
+Please refer to [usage guide](https://github.com/Ze0nC/SwiftPygmentsPublishPlugin#usage) to see how to specify syntax language and more. 
+
+Note that you will need to add css for `Pygments` to actually see the highlighted code. 


"css" -> "CSS".

Also if you're going to use Pygments here (stylized as code) then I recommend stylizing all other mentions of Pygments similarly.

Ze0nC · 2020-01-16T11:38:54Z

Hi. I have fixed the grammar and now looks much better.

Btw I made another plugin to make tags have different colors. I will share it later.

JohnSundell

Awesome, thanks so much @Ze0nC! Looking forward to seeing more plugins 🎉

Ze0nC added 3 commits January 15, 2020 22:24

Create add-syntax-highlighting-with-pygments.md

3da8e49

Updated title.

d3013df

Added link to new Howto md

a92915c

JohnSundell reviewed Jan 15, 2020

View reviewed changes

JohnSundell added the awaiting update Awaiting an update from the PR author label Jan 15, 2020

Ze0nC added 2 commits January 16, 2020 15:10

Simplified the how-to md

91cab18

Details are moved to plugin's readme.md

Changed add to adding

a364f45

JohnSundell reviewed Jan 16, 2020

View reviewed changes

Grammar fix

edba0c2

JohnSundell approved these changes Jan 16, 2020

View reviewed changes

JohnSundell merged commit f478595 into JohnSundell:master Jan 16, 2020

JohnSundell removed the awaiting update Awaiting an update from the PR author label Jan 16, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added article about syntax highlight with Pygments #51

Added article about syntax highlight with Pygments #51

Ze0nC commented Jan 15, 2020

JohnSundell left a comment

JohnSundell Jan 15, 2020

Ze0nC Jan 16, 2020

JohnSundell Jan 15, 2020

Ze0nC Jan 16, 2020

JohnSundell Jan 15, 2020

Ze0nC Jan 16, 2020

Ze0nC commented Jan 16, 2020

JohnSundell left a comment

JohnSundell Jan 16, 2020

JohnSundell Jan 16, 2020

JohnSundell Jan 16, 2020

JohnSundell Jan 16, 2020

JohnSundell Jan 16, 2020

JohnSundell Jan 16, 2020

JohnSundell Jan 16, 2020

Ze0nC commented Jan 16, 2020

JohnSundell left a comment

		@@ -0,0 +1,21 @@
		# How to add syntax highlighting with Pygments
		[Splash](https://github.com/JohnSundell/Splash) and its [official plugin](https://github.com/JohnSundell/SplashPublishPlugin) are great tools for highlighting swift syntax in Publish.


		However, some people write not only in Swift, but also in many other languages. There comes the [SwiftPygmentsPublishPlugin](https://github.com/Ze0nC/SwiftPygmentsPublishPlugin) to help.

		Please follow the plugin's [installation guide](https://github.com/Ze0nC/SwiftPygmentsPublishPlugin#installation) to install pygments and add it to your website's Swift package, and then add it to publishing pipeline:


		Please refer to [usage guide](https://github.com/Ze0nC/SwiftPygmentsPublishPlugin#usage) to see how to specify syntax language and more.

		Note that you will need to add css for `Pygments` to actually see the highlighted code.

Added article about syntax highlight with Pygments #51

Added article about syntax highlight with Pygments #51

Conversation

Ze0nC commented Jan 15, 2020

JohnSundell left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Ze0nC commented Jan 16, 2020

JohnSundell left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Ze0nC commented Jan 16, 2020

JohnSundell left a comment

Choose a reason for hiding this comment