~edwardloveall/scribe

ref: e365ee8be5266f32d2a2597be6cd3501b5e126ee scribe/src/pages/faq/index_page.cr -rw-r--r-- 3.8 KiB
e365ee8bEdward Loveall Add FAQ on how to use Scribe with custom domains 7 months ago
                                                                                
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
class Faq::IndexPage < MainLayout
  def page_title
    "Scribe FAQ"
  end

  def content
    h1 "Frequently Asked Questions"
    article do
      auto_redirect
      why_would_i_want_this
      other_instances
      custom_domains
      mount Shared::LayoutFooter
    end
  end

  private def auto_redirect
    section do
      h2 "How-to Automatically Redirect Medium Articles"
      para do
        text "If you don't want to manually change the URL every time, you can use an extension to do it for you. "
        a "This extension", href: "https://einaregilsson.com/redirector/"
        text " works well across most browsers."
      end
      para "Once installed, create a new redirect with the following settings:"
      ul do
        li do
          strong "Description: "
          code "Medium -> Scribe"
        end
        li do
          strong "Example URL: "
          code "https://medium.com/@user/post-123456abcdef"
        end
        li do
          strong "Include pattern: "
          code "^https?://(?:.*\\.)*(?<!link\\.)medium\\.com(/.*)?$"
        end
        li do
          strong "Redirect to: "
          code "https://"
          code app_domain
          code "$1"
        end
        li do
          strong "Pattern type: "
          code "( ) Wildcard   (•) Regular Expression"
        end
      end
      para "Visiting any medium.com site (including user.medium.com subdomains) should now redirect to Scribe instead!"
    end
  end

  private def why_would_i_want_this
    section do
      h2 "Why Would I Want to Use This?"
      para do
        text "There are a number of potential reasons:"
        ul do
          li do
            text "You believe in an "
            a "open web", href: "http://scripting.com/liveblog/users/davewiner/2016/01/20/0900.html"
          end
          li do
            text "You believe more in "
            a "the author", href: "https://www.manton.org/2016/01/15/silos-as-shortcuts.html"
            text " than the platform"
          end
          li do
            text "You "
            a "don't like the reading experience", href: "https://twitter.com/BretFisher/status/1206766086961745920"
            text " that Medium provides"
          end
          li do
            text "You object to "
            a "Medium's extortionist business tactics", href: "https://www.cdevn.com/why-medium-actually-sucks/"
          end
          li do
            text "You're concerned about how "
            a "Medium uses your data", href: "https://tosdr.org/en/service/1003"
          end
          li do
            a "Other reasons", href: "https://nomedium.dev/"
          end
        end
      end
    end
  end

  private def other_instances
    section do
      h2 "Can I use Scribe on a different website? (instances)"
      para do
        text "You can! See "
        a(
          "this list",
          href: "https://git.sr.ht/~edwardloveall/scribe/tree/main/docs/instances.md"
        )
        text " in the documentation."
      end
    end
  end

  private def custom_domains
    section do
      h2 "What about Medium articles on custom domains?"
      para do
        text <<-TEXT
          Scribe can read these also. The URL just needs to end with the
          characters at the end of the URL called the Post ID. Here's an
          example:
        TEXT
      end
      para do
        code "example.com/my-post-"
        code "09a6af907a2", class: "highlight"
        text " can be converted to "
        br
        code app_domain
        code "/my-post-"
        code "09a6af907a2", class: "highlight"
      end
      para do
        text <<-TEXT
          To redirect automatically, follow the intructions above to on how to
          redirect medium articles. Replace
        TEXT
        code " medium\\.com"
        text " with the domain of your choosing."
      end
    end
  end
end