vitepress-rails 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13c5b41037eb03ea1741a3c22c26852bb30c55fe06d9fd462e1bfd9b36df3753
-  data.tar.gz: 619b3b0f6f5fce0f5307911951802f8c3ad919daf783d177ffc261c841e0d5a3
+  metadata.gz: c636f90fd6fdf0dbc716b1f76d004fe6e1ebf9ed6e1a8938715d8b5a824fe21f
+  data.tar.gz: d060c216290429ffe1b1eb0ecc82da14346e5703a5d1efbad4bba6b54ec1026a
 SHA512:
-  metadata.gz: 278a577f49d1227a645636c0064c92e508dcec77f9e9311c9d87c227bab55945402f9d606631aae80d7b3c152c0dab5eccff2980fca7b2995757fc88760a399e
-  data.tar.gz: 95142f46e97aeec20ec8ef2852bbbe13b30fa29e55fec443738808bf25f48e359ab1ba7c7bc6deb410dbacafa77650c5e2622ad635a09e9b8ce3b37b61fd8606
+  metadata.gz: ae912ab669c78d0836ec5fdeb32b63cf4cb5e201e0ffe8a9b0d7e8ad971a328ffe4f6737c498903cadce74e63cba98516f87875c0dacc6e3bf988d83216e2777
+  data.tar.gz: 2d31ac3be029f6b39f56b6399f39187d79c4a10f50ff3a9f423c614ddb93c8421373d43c92b10cfd99f139bc8422b486341f0b151b9e88d1b3779bcf3792ae81

data/Gemfile.lock

@@ -0,0 +1,217 @@
+PATH
+  remote: .
+  specs:
+    vitepress-rails (0.1.4)
+      high_voltage (~> 3.1)
+      rails (>= 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activejob (= 7.0.4.3)
+      activerecord (= 7.0.4.3)
+      activestorage (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      actionview (= 7.0.4.3)
+      activejob (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.0)
+    actionpack (7.0.4.3)
+      actionview (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activerecord (= 7.0.4.3)
+      activestorage (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.0.4.3)
+      activesupport (= 7.0.4.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (7.0.4.3)
+      activesupport (= 7.0.4.3)
+      globalid (>= 0.3.6)
+    activemodel (7.0.4.3)
+      activesupport (= 7.0.4.3)
+    activerecord (7.0.4.3)
+      activemodel (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+    activestorage (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activejob (= 7.0.4.3)
+      activerecord (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (7.0.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    concurrent-ruby (1.2.2)
+    crass (1.0.6)
+    date (3.3.3)
+    diff-lcs (1.5.0)
+    erubi (1.12.0)
+    globalid (1.1.0)
+      activesupport (>= 5.0)
+    high_voltage (3.1.2)
+    i18n (1.13.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    loofah (2.20.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    minitest (5.18.0)
+    net-imap (0.3.4)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.1)
+      timeout
+    net-smtp (0.3.3)
+      net-protocol
+    nio4r (2.5.9)
+    nokogiri (1.14.3-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    racc (1.6.2)
+    rack (2.2.7)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails (7.0.4.3)
+      actioncable (= 7.0.4.3)
+      actionmailbox (= 7.0.4.3)
+      actionmailer (= 7.0.4.3)
+      actionpack (= 7.0.4.3)
+      actiontext (= 7.0.4.3)
+      actionview (= 7.0.4.3)
+      activejob (= 7.0.4.3)
+      activemodel (= 7.0.4.3)
+      activerecord (= 7.0.4.3)
+      activestorage (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      bundler (>= 1.15.0)
+      railties (= 7.0.4.3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.5.0)
+      loofah (~> 2.19, >= 2.19.1)
+    railties (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.50.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
+    rubocop-performance (1.17.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.19.1)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.33.0, < 2.0)
+    rubocop-rspec (2.20.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+    rubocop-shopify (2.13.0)
+      rubocop (~> 1.50)
+    ruby-progressbar (1.13.0)
+    switchcop (0.1.3)
+      rubocop (~> 1.48)
+      rubocop-performance (~> 1.16)
+      rubocop-rails (~> 2.18)
+      rubocop-rspec (~> 2.19)
+      rubocop-shopify (~> 2.12)
+    thor (1.2.1)
+    timeout (0.3.2)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.7)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  switchcop
+  vitepress-rails!
+
+BUNDLED WITH
+   2.4.10

data/README.md

@@ -2,6 +2,10 @@
 
 Integrate [Vitepress](https://vitepress.vuejs.org/) into your Rails application.
 
+## When you should use this gem?
+
+- The primary use case is for private documentation that utilizes your Rails authentication system
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -25,17 +29,19 @@ This command creates docs folder that contains the Vitepress default application
 2. Adds the following line to your `config/routes.rb` file:
 
 ```ruby
-mount Vitepress::Engine, at: "/"
+mount Vitepress::Engine, at: "/docs"
 ```
-***Only works with / path for now***
+
+- ***Only works with /docs path for now***
+- In your vitepress config file needs to have base: '/docs/'.
 
 ## Usage
 
-1. Write your `.md` doc inside the `docs` folder. 
+1. Write your `.md` doc inside the `docs` folder.
 2. Run `rails assets:precompile`.
 3. Your page can be accessed at `/docs/<your-page-name>`
 
-Your `/` path always will be `docs/index.md`
+Your `/docs` path always will be `docs/index.md`
 
 ## Development
 
@@ -59,4 +65,5 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## Code of Conduct
 
 Everyone interacting in the Vitepress::Rails project's codebases, issue trackers, chat rooms and mailing lists is
-expected to follow the [code of conduct](https://github.com/SwitchDreams/vitepress-rails/blob/master/CODE_OF_CONDUCT.md).
+expected to follow
+the [code of conduct](https://github.com/SwitchDreams/vitepress-rails/blob/master/CODE_OF_CONDUCT.md).

data/lib/vitepress/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Vitepress
   module Rails
-    VERSION = "0.1.3"
+    VERSION = "0.1.4"
   end
 end

data/lib/vitepress/tasks/vitepress/build.rake

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+DEFAULT_BASE_PATH = "docs/"
+DOCS_PUBLIC_FOLDER_PATH = "../public/#{DEFAULT_BASE_PATH}"
+
 namespace :vitepress do
   desc "Build your docs"
   task build: :environment do
@@ -19,14 +22,17 @@ namespace :vitepress do
         FileUtils.copy_file(file, File.join(dest, filename))
       end
 
+      # Create docs public folder
+      Dir.mkdir(DOCS_PUBLIC_FOLDER_PATH) unless Dir.exist?(DOCS_PUBLIC_FOLDER_PATH)
+
       # Move assets files to public
       if Dir.exist?(".vitepress/dist/assets")
-        FileUtils.copy_entry(".vitepress/dist/assets", "../public/assets")
+        FileUtils.copy_entry(".vitepress/dist/assets", "#{DOCS_PUBLIC_FOLDER_PATH}assets")
       end
 
       # Copy public files
       if Dir.exist?("public")
-        FileUtils.copy_entry("public", "../public")
+        FileUtils.copy_entry("public", DOCS_PUBLIC_FOLDER_PATH)
       end
     end
   end

data/lib/vitepress/tasks/vitepress/init/config.js

@@ -1,4 +1,6 @@
 export default {
   title: 'VitePress Rails',
   description: 'Docs with vitepress-rails',
+  base: '/docs/',
+  cleanUrls: true,
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vitepress-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - PedroAugustoRamalhoDuarte
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-27 00:00:00.000000000 Z
+date: 2023-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: high_voltage
@@ -46,6 +46,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
+- Gemfile.lock
 - README.md
 - Rakefile
 - app/controllers/concerns/vitepress/page.rb