Главная Обзор Помощь
Вход
cturan
/
vendure
зеркало из https://github.com/vendure-ecommerce/vendure
1
0
Ответвить 0
Файлы Задачи 0 Вики
Просмотр исходного кода

fix(docs): Fix misconfiguration with urls & build script

Michael Bromley 7 лет назад
Родитель
ec9eacbd21
Сommit
3069beeaee
11 измененных файлов с 43 добавлено и 43 удалено
Разделённый вид Показать статистику Diff
  1. 2 2
      docs/config.toml
  2. 2 2
      docs/layouts/blog/list.html
  3. 26 26
      docs/layouts/index.en.html
  4. 2 2
      docs/layouts/partials/docs/git-footer.html
  5. 3 3
      docs/layouts/partials/docs/html-head.html
  6. 1 1
      docs/layouts/partials/docs/menu-filetree.html
  7. 1 1
      docs/layouts/partials/docs/mobile-header.html
  8. 1 1
      docs/layouts/partials/footer.html
  9. 2 2
      docs/layouts/partials/intro.html
  10. 2 2
      docs/layouts/partials/top-bar.html
  11. 1 1
      package.json

+ 2 - 2
docs/config.toml
Просмотреть файл 

@@ -1,6 +1,6 @@
 
-baseURL = "http://example.org/"
 
+baseURL = "http://www.vendure.io/"
 
 languageCode = "en-us"
 
-title = "Vendure"
 
+title = "Vendure E-commerce"
 
 googleAnalytics = "UA-133911942-1"
 
 pygmentsCodeFences = true
 
 pygmentsUseClasses = true

+ 2 - 2
docs/layouts/blog/list.html
Просмотреть файл 

@@ -4,7 +4,7 @@
 
     {{ range sort .Paginator.Pages }}
 
     <article class="book-posts mx-auto">
 
         <h2>
 
-            <a href="{{ .Permalink }}">{{ .Title }}</a>
 
+            <a href="{{ .RelPermalink }}">{{ .Title }}</a>
 
         </h2>
 
         <h5>
 
             <strong>{{ .Date.Format "January 2, 2006" }}</strong>
 
@@ -12,7 +12,7 @@
 
         <p>
 
             {{- .Summary -}}
 
             {{ if .Truncated }}
 
-            <a href="{{ .Permalink }}">...</a>
 
+            <a href="{{ .RelPermalink }}">...</a>
 
             {{ end }}
 
         </p>
 
     </article>

+ 26 - 26
docs/layouts/index.en.html
Просмотреть файл 

@@ -2,7 +2,7 @@
 
 <html lang="en">
 
 <head>
 
     {{ partial "docs/html-head" . }}
 
-    <link rel="stylesheet" href="{{ "intro.css" | absURL }}">
 
+    <link rel="stylesheet" href="{{ "intro.css" | relURL }}">
 
 </head>
 
 <body class="landing-page">
 
 {{ partial "top-bar" (dict "isLandingPage" true) }}
 
@@ -11,22 +11,22 @@
 
     <div class="content">
 
         <h2>E-commerce for the Modern Web</h2>
 
         <p class="lead">Vendure is a new e-commerce framework built for the developers who are building the modern web.<br> 
-            <img src="{{ "svg/clr-icon-book-light.svg" | absURL }}" alt="check icon"> Read: <a href="{{ "blog/introducing-vendure" | absURL }}">Introducing Vendure</a></p>
 
+            <img src="{{ "svg/clr-icon-book-light.svg" | relURL }}" alt="check icon"> Read: <a href="{{ "blog/introducing-vendure" | relURL }}">Introducing Vendure</a></p>
 
         <iframe src="https://player.vimeo.com/video/315862294" 
             title="intro video"
 
             class="vimeo-player" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
 
         <div class="stack-logos">
 
             <div class="stack-logo ts-logo">
 
-                <img src="{{ "logo/ts-logo.svg" | absURL }}">
 
+                <img src="{{ "logo/ts-logo.svg" | relURL }}">
 
             </div>
 
             <div class="stack-logo graphql-logo">
 
-                <img src="{{ "logo/graphql-logo.png" | absURL }}">
 
+                <img src="{{ "logo/graphql-logo.png" | relURL }}">
 
             </div>
 
             <div class="stack-logo node-logo">
 
-                <img src="{{ "logo/nodejs-logo.png" | absURL }}">
 
+                <img src="{{ "logo/nodejs-logo.png" | relURL }}">
 
             </div>
 
             <div class="stack-logo nest-logo">
 
-                <img src="{{ "logo/nest-logo.svg" | absURL }}">
 
+                <img src="{{ "logo/nest-logo.svg" | relURL }}">
 
             </div>
 
         </div>
 
     </div>
 
@@ -44,7 +44,7 @@
 
                     </p>
 
                 </div>
 
                 <div class="feature-image">
 
-                    <img src="{{ "features-code.png" | absURL }}">
 
+                    <img src="{{ "features-code.png" | relURL }}">
 
                 </div>
 
             </div>
 
 
@@ -60,7 +60,7 @@
 
                     </p>
 
                 </div>
 
                 <div class="feature-image">
 
-                    <img src="{{ "features-dev.png" | absURL }}">
 
+                    <img src="{{ "features-dev.png" | relURL }}">
 
                 </div>
 
             </div>
 
 
@@ -75,7 +75,7 @@
 
                     </p>
 
                 </div>
 
                 <div class="feature-image">
 
-                    <img src="{{ "features-oss.png" | absURL }}">
 
+                    <img src="{{ "features-oss.png" | relURL }}">
 
                 </div>
 
             </div>
 
         </div>
 
@@ -86,20 +86,20 @@
 
         <h2>Features</h2>
 
         <div class="features">
 
         <ul class="feature-list">
 
-            <li><img src="{{ "svg/clr-icon-check-brand.svg" | absURL }}" alt="check icon">Products & variants</li>
 
-            <li><img src="{{ "svg/clr-icon-check-brand.svg" | absURL }}" alt="check icon">Stock management</li>
 
-            <li><img src="{{ "svg/clr-icon-check-brand.svg" | absURL }}" alt="check icon">On-the-fly image resize & crop</li>
 
-            <li><img src="{{ "svg/clr-icon-check-brand.svg" | absURL }}" alt="check icon">Product facets & faceted search</li>
 
-            <li><img src="{{ "svg/clr-icon-check-brand.svg" | absURL }}" alt="check icon">Product categories / collections</li>
 
-            <li><img src="{{ "svg/clr-icon-check-brand.svg" | absURL }}" alt="check icon">Extensible product search via Elastic, Algolia etc.</li>
 
-            <li><img src="{{ "svg/clr-icon-check-brand.svg" | absURL }}" alt="check icon">Payment provider integrations</li>
 
-            <li><img src="{{ "svg/clr-icon-check-brand.svg" | absURL }}" alt="check icon">Shipping provider integrations</li>
 
-            <li><img src="{{ "svg/clr-icon-check-brand.svg" | absURL }}" alt="check icon">Tax calculations based on category and zone</li>
 
-            <li><img src="{{ "svg/clr-icon-check-brand.svg" | absURL }}" alt="check icon">Discounts and promotions</li>
 
-            <li><img src="{{ "svg/clr-icon-check-brand.svg" | absURL }}" alt="check icon">Multiple administrators with fine-grained permissions</li>
 
-            <li><img src="{{ "svg/clr-icon-check-brand.svg" | absURL }}" alt="check icon">Built-in admin interface</li>
 
-            <li><img src="{{ "svg/clr-icon-check-brand.svg" | absURL }}" alt="check icon">Multi-language support</li>
 
-            <li><img src="{{ "svg/clr-icon-check-brand.svg" | absURL }}" alt="check icon">Guest checkouts</li>
 
+            <li><img src="{{ "svg/clr-icon-check-brand.svg" | relURL }}" alt="check icon">Products & variants</li>
 
+            <li><img src="{{ "svg/clr-icon-check-brand.svg" | relURL }}" alt="check icon">Stock management</li>
 
+            <li><img src="{{ "svg/clr-icon-check-brand.svg" | relURL }}" alt="check icon">On-the-fly image resize & crop</li>
 
+            <li><img src="{{ "svg/clr-icon-check-brand.svg" | relURL }}" alt="check icon">Product facets & faceted search</li>
 
+            <li><img src="{{ "svg/clr-icon-check-brand.svg" | relURL }}" alt="check icon">Product categories / collections</li>
 
+            <li><img src="{{ "svg/clr-icon-check-brand.svg" | relURL }}" alt="check icon">Extensible product search via Elastic, Algolia etc.</li>
 
+            <li><img src="{{ "svg/clr-icon-check-brand.svg" | relURL }}" alt="check icon">Payment provider integrations</li>
 
+            <li><img src="{{ "svg/clr-icon-check-brand.svg" | relURL }}" alt="check icon">Shipping provider integrations</li>
 
+            <li><img src="{{ "svg/clr-icon-check-brand.svg" | relURL }}" alt="check icon">Tax calculations based on category and zone</li>
 
+            <li><img src="{{ "svg/clr-icon-check-brand.svg" | relURL }}" alt="check icon">Discounts and promotions</li>
 
+            <li><img src="{{ "svg/clr-icon-check-brand.svg" | relURL }}" alt="check icon">Multiple administrators with fine-grained permissions</li>
 
+            <li><img src="{{ "svg/clr-icon-check-brand.svg" | relURL }}" alt="check icon">Built-in admin interface</li>
 
+            <li><img src="{{ "svg/clr-icon-check-brand.svg" | relURL }}" alt="check icon">Multi-language support</li>
 
+            <li><img src="{{ "svg/clr-icon-check-brand.svg" | relURL }}" alt="check icon">Guest checkouts</li>
 
         </ul>
 
         </div>
 
         <p><small>The above features are either already implemented or planned for the beta release</small></p>
 
@@ -126,14 +126,14 @@ $ yarn add @vendure/core@alpha</code>
 
                     <strong>Note</strong> Vendure is currently in <strong>alpha</strong>, which means it is not yet production-ready.
 
                     </p>
 
                 </div>
 
-                <a href="{{ "docs/getting-started" | absURL }}" class="getting-started-button">
 
-                <img src="{{ "svg/clr-icon-bolt-light.svg" | absURL }}"> Getting Started Guide
 
+                <a href="{{ "docs/getting-started" | relURL }}" class="getting-started-button">
 
+                <img src="{{ "svg/clr-icon-bolt-light.svg" | relURL }}"> Getting Started Guide
 
                 </a>
 
             </div>
 
         </div>
 
     </div>
 
 </div>
 
 {{ partial "footer" }}
 
-<script src="{{ "intro.js" | absURL }}"></script>
 
+<script src="{{ "intro.js" | relURL }}"></script>
 
 </body>
 
 </html>

+ 2 - 2
docs/layouts/partials/docs/git-footer.html
Просмотреть файл 

@@ -3,14 +3,14 @@
 
   {{ with .GitInfo }}
 
   <div>
 
     <a href="{{ $.Site.Params.BookRepo }}/commit/{{ .Hash }}" title='Last modified {{ .AuthorDate.Local.Format "January 2, 2006 15:04 MST" }} by {{ .AuthorName }}' target="_blank" rel="noopener">
 
-      <img src="{{ "svg/code-merge.svg" | absURL }}" /> {{ .AuthorDate.Local.Format "Last Modified Jan 2, 2006" }}
 
+      <img src="{{ "svg/code-merge.svg" | relURL }}" /> {{ .AuthorDate.Local.Format "Last Modified Jan 2, 2006" }}
 
     </a>
 
   </div>
 
   {{ end }}
 
   {{ with .Site.Params.BookEditPath }}
 
   <div>
 
     <a href="{{ $.Site.Params.BookRepo }}/{{ . }}/{{ $.File.Path }}" target="_blank" rel="noopener">
 
-      <img src="{{ "svg/code-fork.svg" | absURL }}" /> Edit this page
 
+      <img src="{{ "svg/code-fork.svg" | relURL }}" /> Edit this page
 
     </a>
 
   </div>
 
   {{ end }}

+ 3 - 3
docs/layouts/partials/docs/html-head.html
Просмотреть файл 

@@ -3,6 +3,6 @@
 
 <title>{{- template "title" . }} | {{ .Site.Title -}}</title>
 
 
 <link href="https://fonts.googleapis.com/css?family=Didact+Gothic|Source+Code+Pro|Open+Sans" rel="stylesheet">
 
-<link rel="stylesheet" href="{{ "normalize.min.css" | absURL }}">
 
-<link rel="stylesheet" href="{{ "main.css" | absURL }}">
 
-<script src="{{ "main.js" | absURL }}"></script>
 
+<link rel="stylesheet" href="{{ "normalize.min.css" | relURL }}">
 
+<link rel="stylesheet" href="{{ "main.css" | relURL }}">
 
+<script src="{{ "main.js" | relURL }}"></script>

+ 1 - 1
docs/layouts/partials/docs/menu-filetree.html
Просмотреть файл 

@@ -14,7 +14,7 @@
 
             <li class="section">
 
                 {{ $expanded := in $.CurrentPage .Permalink }}
 
                 <div class="section-link">
 
-                <img src="{{ "svg/clr-icon-angle.svg" | absURL }}" class="section-icon {{ if $expanded}}expanded{{ end }}" />
 
+                <img src="{{ "svg/clr-icon-angle.svg" | relURL }}" class="section-icon {{ if $expanded}}expanded{{ end }}" />
 
                 {{ template "book-page-link" (dict "Page" . "CurrentPage" $.CurrentPage) }}
 
                 </div>
 
                 {{ template "book-section" (dict "Section" . "CurrentPage" $.CurrentPage "Expanded" $expanded) }}

+ 1 - 1
docs/layouts/partials/docs/mobile-header.html
Просмотреть файл 

@@ -1,6 +1,6 @@
 
 <header class="align-center justify-between book-header">
 
   <label for="menu-control">
 
-    <img src="{{ "svg/menu.svg" | absURL }}" />
 
+    <img src="{{ "svg/menu.svg" | relURL }}" />
 
   </label>
 
   <strong>{{- template "title" . }}</strong>
 
 </header>

+ 1 - 1
docs/layouts/partials/footer.html
Просмотреть файл 

@@ -7,7 +7,7 @@
 
                 <li><a href="https://github.com/vendure-ecommerce/vendure">GitHub</a></li>
 
                 <li><a href="https://www.npmjs.com/~vendure">npm</a></li>
 
                 <li><a href="https://twitter.com/vendure_io">Twitter</a></li>
 
-                <li><a href="mailto:contact@vendure.io" class="email-link"><img src="{{ "svg/clr-icon-email-light.svg" | absURL }}"> contact@vendure.io</a></li>
 
+                <li><a href="mailto:contact@vendure.io" class="email-link"><img src="{{ "svg/clr-icon-email-light.svg" | relURL }}"> contact@vendure.io</a></li>
 
             </ul>
 
         </div>
 
         <div class="copyright">

+ 2 - 2
docs/layouts/partials/intro.html
Просмотреть файл 

@@ -73,7 +73,7 @@
 
             </div>
 
         </div>
 
         <div class="intro-controls">
 
-            <button id="replay" title="replay animation"><img src="{{ "svg/clr-icon-replay-all.svg" | absURL }}"></button>
 
+            <button id="replay" title="replay animation"><img src="{{ "svg/clr-icon-replay-all.svg" | relURL }}"></button>
 
             <div class="jump">
 
                 <button id="scene-0-button" title="jump to animation scene 0"></button>
 
                 <button id="scene-1-button" title="jump to animation scene 1"></button>
 
@@ -89,7 +89,7 @@
 
             <div class="subhead">
 
                 A modern, headless <a href="https://graphql.org/">GraphQL</a>-based e-commerce framework built with <a href="http://www.typescriptlang.org">TypeScript</a> & <a href="https://nodejs.org">Nodejs</a>
 
             </div>
 
-            <img src="{{ "svg/clr-icon-angle.svg" | absURL }}" class="more-icon" />
 
+            <img src="{{ "svg/clr-icon-angle.svg" | relURL }}" class="more-icon" />
 
         </div>
 
     </div>
 
 </div>

+ 2 - 2
docs/layouts/partials/top-bar.html
Просмотреть файл 

@@ -2,7 +2,7 @@
 
     <div class="top-bar-content">
 
         <div class="left">
 
             <a class="logo" href="/" title="back to landing page">
 
-                <img src="{{ "logo.png" | absURL }}" />
 
+                <img src="{{ "logo.png" | relURL }}" />
 
                 {{ if not .isLandingPage }}<div class="logotype">vendure</div>{{ end }}
 
             </a>
 
             <div class="alpha-label">alpha</div>
 
@@ -11,7 +11,7 @@
 
         {{ if .isDocsPage }}
 
         <div class="search-input">
 
             <button class="search-icon">
 
-                <img src="{{ "svg/clr-icon-search-light.svg" | absURL }}">
 
+                <img src="{{ "svg/clr-icon-search-light.svg" | relURL }}">
 
             </button>
 
             <input id="searchInput" placeholder="Search docs">
 
         </div>

+ 1 - 1
package.json
Просмотреть файл 

@@ -5,10 +5,10 @@
 
   "scripts": {
 
     "docs:watch": "concurrently -n docgen,hugo,webpack -c green,blue,cyan \"yarn generate-api-docs && yarn generate-config-docs -w\" \"cd docs && hugo server\" \"cd docs && yarn webpack -w\"",
 
     "docs:build": "yarn generate-api-docs && yarn generate-config-docs && cd docs && yarn webpack --prod && hugo",
 
+    "docs:deploy": "cd docs && yarn && cd .. && yarn docs:build",
 
     "generate-gql-types": "ts-node ./codegen/generate-graphql-types.ts",
 
     "generate-config-docs": "ts-node ./codegen/generate-config-docs.ts",
 
     "generate-api-docs": "ts-node ./codegen/generate-api-docs.ts",
 
-    "postinstall": "cd admin-ui && yarn && cd ../server && yarn",
 
     "test": "cd admin-ui && yarn test --watch=false --browsers=ChromeHeadlessCI --progress=false && cd ../server && yarn test && yarn test:e2e",
 
     "format": "prettier --write --html-whitespace-sensitivity ignore",
 
     "lint:server": "cd server && yarn lint --fix",