Merge pull request #22 from mihaiconstantin/feat/package-docs

Add package documentation via `VuePress`. Closes #7.

Author: mihaiconstantin

.Rbuildignore

@@ -9,3 +9,7 @@ archive
 ^man-roxygen$
 CNAME
 temp.R
+docs/
+package-lock.json
+package.json
+node_modules/

.github/workflows/docs.yml

@@ -0,0 +1,64 @@
+# Workflow name.
+name: docs
+
+# Events.
+on:
+  # Trigger on push to branch.
+  push:
+    branches: [main]
+  # Trigger manually via the GitHub UI.
+  workflow_dispatch:
+
+# Jobs.
+jobs:
+  docs:
+    # Virtual machine type.
+    runs-on: ubuntu-latest
+
+    # Job steps.
+    steps:
+      # Fetch all commits to get all `.git` info logs.
+      - name: Checkout repository
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      # Install `Node.js`.
+      - name: Setup Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: '14'
+
+      # Cache `node_modules`.
+      - name: Cache dependencies
+        uses: actions/cache@v2
+        id: yarn-cache
+        with:
+          path: |
+            **/node_modules
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+
+      # Install `Node.js` dependencies if the cache did not hit.
+      - name: Install dependencies
+        if: steps.yarn-cache.outputs.cache-hit != 'true'
+        run: yarn --frozen-lockfile
+
+      # Run build script.
+      - name: Build VuePress site
+        run: yarn docs:build
+
+      # Deploy website.
+      # https://github.com/crazy-max/ghaction-github-pages.
+      - name: Deploy to GitHub Pages
+        uses: crazy-max/ghaction-github-pages@v2
+        with:
+          # Deploy to `gh-pages` branch.
+          target_branch: gh-pages
+          # Deploy the default output dir of VuePress.
+          build_dir: docs/.vuepress/dist
+          # Write the given domain name to the CNAME file.
+          fqdn: powerly.dev
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -6,3 +6,7 @@ archive
 powerly.Rcheck/
 *.tar.gz
 **/temp*
+node_modules/
+.temp
+.cache
+dist

NEWS.md

@@ -3,6 +3,11 @@ All notable changes to this project will be documented in this file. The format
 is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this
 project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## development
+### Added
+- Add starter package documentation via `VuePress`. The deployed documentation
+  files can be accessed at [powerly.dev](https://powerly.dev).
+
 ## 1.8.2 - 2022-07-22
 ### Fixed
 - Remove square brackets from version numbers in `NEWS.md` to allow CRAN to

docs/.vuepress/config.ts

@@ -0,0 +1,38 @@
+import { defineUserConfig } from "vuepress"
+import { defaultTheme } from "vuepress";
+import { sidebar, navbar, head } from "./configs";
+import { katexPlugin } from "@renovamen/vuepress-plugin-katex";
+import { shikiPlugin } from '@vuepress/plugin-shiki';
+
+/**
+ * VuePress config.
+ */
+export default defineUserConfig({
+    base: "/",
+    lang: "en-US",
+    title: "powerly",
+    description: "Sample Size Analysis for Psychological Networks and more...",
+    head: head,
+    theme: defaultTheme({
+        docsDir: "docs",
+        docsBranch: "main",
+        repoLabel: "GitHub",
+        lastUpdated: true,
+        contributors: true,
+        navbar: navbar,
+        sidebar: sidebar,
+        sidebarDepth: 2,
+        logo: "/images/logos/powerly-logo.png",
+        repo: "https://github.com/mihaiconstantin/powerly",
+        editLinkText: "Edit this page on GitHub"
+    }),
+    plugins: [
+        // LaTeX plugin.
+        katexPlugin(),
+
+        // Syntax highlighting plugin.
+        shikiPlugin({
+            theme: "dark-plus"
+        })
+    ]
+})

docs/.vuepress/configs/head.ts

@@ -0,0 +1,33 @@
+import type { HeadConfig } from '@vuepress/core'
+
+
+/**
+ * Header links.
+ */
+export const head: HeadConfig[] = [
+  [
+    'link',
+    {
+      rel: 'icon',
+      type: 'image/png',
+      sizes: '16x16',
+      href: `/images/icons/favicon-16x16.png`,
+    },
+  ],
+  [
+    'link',
+    {
+      rel: 'icon',
+      type: 'image/png',
+      sizes: '32x32',
+      href: `/images/icons/favicon-32x32.png`,
+    },
+  ],
+  ['meta', { name: 'application-name', content: 'powerly' }],
+  ['meta', { name: 'apple-mobile-web-app-title', content: 'powerly' }],
+  ['meta', { name: 'apple-mobile-web-app-status-bar-style', content: 'black' }],
+  [
+    'link',
+    { rel: 'apple-touch-icon', href: `/images/icons/apple-touch-icon.png` },
+  ],
+]

docs/.vuepress/configs/index.ts

@@ -0,0 +1,3 @@
+export * from './head';
+export * from './sidebar';
+export * from './navbar';

docs/.vuepress/configs/navbar.ts

@@ -0,0 +1,32 @@
+import type { NavbarConfig } from '@vuepress/theme-default';
+
+
+/**
+ * Navbar links.
+ */
+export const navbar: NavbarConfig = [
+    {
+        text: "Tutorials",
+        link: "/tutorial/"
+    },
+    {
+        text: "Reference",
+        link: "/reference/"
+    },
+    {
+        text: "Publications",
+        link: "/publication/"
+    },
+    {
+        text: "Developer",
+        link: "/developer/"
+    },
+    {
+        text: "News",
+        link: "https://github.com/mihaiconstantin/powerly/blob/main/NEWS.md"
+    },
+    {
+        text: "CRAN",
+        link: "https://CRAN.R-project.org/package=powerly"
+    }
+]

docs/.vuepress/configs/sidebar.ts

@@ -0,0 +1,39 @@
+import type { SidebarConfig } from '@vuepress/theme-default';
+
+
+/**
+ * Sidebar links.
+ */
+export const sidebar: SidebarConfig = {
+    "/tutorial/": [
+        "/tutorial/index.md",
+        "/tutorial/method.md",
+        {
+            text: 'Applications',
+            collapsible: true,
+            children: [
+                "/tutorial/application/power-psychological-networks.md",
+                "/tutorial/application/power-structural-equation-modeling.md",
+                "/tutorial/application/power-multilevel-models.md",
+            ]
+        },
+        {
+            text: 'FAQ',
+            collapsible: true,
+            children: [
+                "/tutorial/faq/choosing-the-initial-range.md",
+                "/tutorial/faq/validating-the-results.md",
+                "/tutorial/faq/choosing-the-true-model.md",
+            ]
+        },
+    ],
+    "/reference/": [
+        "/reference/index.md",
+    ],
+    "/publication/": [
+        "/publication/index.md",
+    ],
+    "/developer/": [
+        "/developer/index.md",
+    ]
+}