diff --git a/README.md b/README.md index 9629e5d..1c2e6a1 100644 --- a/README.md +++ b/README.md @@ -85,13 +85,13 @@ The developer reviews, merges changes and deploys. ## Installation -Add this line to your application's Gemfile: +Add to your Gemfile: ```ruby gem "merged" , git: "https://github.com/HubFeenixMakers/merged" ``` -And then execute: +And then bundle: ```bash $ bundle ``` @@ -99,7 +99,7 @@ $ bundle Mount engine in routes for editing (possibly not in production). ```ruby -mount Merged::Engine => "/merged" +mount Merged::Engine => "/merged" unless Rails.env.production? ``` Create route to serve content. @@ -126,10 +126,9 @@ pipeline. #### Apps using tailwind -If you use tailwind with the basic install, you need to edit the tailwind config. +If you use tailwind with the tailwind gem, you need to edit the tailwind config. -Basically it is impossible to have two tailwind generated stylesheets, so your app needs to pick -up the merged styles. This can be configured like so: +Basically it is impossible to have two tailwind generated stylesheets, so your app needs to pick up the merged styles. This can be configured like so: ``` const output = execSync('bundle show merged', { encoding: 'utf-8' }); @@ -143,6 +142,11 @@ module.exports = { ] ``` +Also, merged overrides some tailwind styles (especially prose/markdown), +so if you want to use markdown i suggest importing the `merged/tailwind_styles` into your application.css. This is pure css, and does not +need to be processed by tailwind. + + ## Developers ### Styles diff --git a/app/assets/stylesheets/merged/merged.css b/app/assets/stylesheets/merged/merged.css index 08478b8..67765ff 100644 --- a/app/assets/stylesheets/merged/merged.css +++ b/app/assets/stylesheets/merged/merged.css @@ -2645,14 +2645,10 @@ select { transition-timing-function: cubic-bezier(0.4, 0, 1, 1); } -.prose{ - color: inherit; - --tw-prose-bullets: #6b7280; -} - -.prose-lg{ +.prose { color: inherit; --tw-prose-bullets: #6b7280; + --tw-prose-headings: inherit; } .hover\:scale-105:hover { diff --git a/app/assets/stylesheets/merged/tailwind_styles.css b/app/assets/stylesheets/merged/tailwind_styles.css index d88d12a..066b327 100644 --- a/app/assets/stylesheets/merged/tailwind_styles.css +++ b/app/assets/stylesheets/merged/tailwind_styles.css @@ -1,9 +1,5 @@ -.prose{ - color: inherit; - --tw-prose-bullets: #6b7280; -} - -.prose-lg{ +.prose { color: inherit; --tw-prose-bullets: #6b7280; + --tw-prose-headings: inherit; }