Merge pull request #166 from Kevin-Lee/task/165/add-website-using-doc…

…usaurus Task #165 - Changed: The doc site is now built using Docusaurus
kevin-lee · Jul 25, 2020 · d29fd61 · d29fd61
2 parents a8ee098 + 78b4610
commit d29fd61
Show file tree

Hide file tree

Showing 36 changed files with 13,530 additions and 92 deletions.
diff --git a/docs/docs/docs/index.md b/docs/docs/docs/index.md
diff --git a/docs/docs/docs/typeclass/applicative.md b/docs/docs/docs/typeclass/applicative.md
diff --git a/docs/docs/docs/typeclass/either-t.md b/docs/docs/docs/typeclass/either-t.md
diff --git a/docs/docs/index.md → docs/getting-started.md b/docs/docs/index.md → docs/getting-started.md
@@ -1,10 +1,9 @@
 ---
-layout: home
-title:  "Just FP"
-section: "home"
+id: 'getting-started'
+title: 'Getting Started'
 ---
 
-# just-fp
+## ![](../img/just-fp-logo-64x64.png) just-fp
 
 [![Build Status](https://github.com/Kevin-Lee/just-fp/workflows/Build%20All/badge.svg)](https://github.com/Kevin-Lee/just-fp/actions?workflow=Build+All)
 [![Release Status](https://github.com/Kevin-Lee/just-fp/workflows/Release/badge.svg)](https://github.com/Kevin-Lee/just-fp/actions?workflow=Release)
@@ -14,8 +13,23 @@ section: "home"
 [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.kevinlee/just-fp_2.13/badge.svg)](https://search.maven.org/artifact/io.kevinlee/just-fp_2.13)
 [![Latest version](https://index.scala-lang.org/kevin-lee/just-fp/just-fp/latest.svg)](https://index.scala-lang.org/kevin-lee/just-fp/just-fp)
 
+just-fp is a small Functional Programming library. This is not meant to be an alternative to Scalaz or Cats. The reason for having this library is that in your project you don't want to have Scalaz or Cats as its dependency and you only need much smaller set of functional programming features than what Scalaz or Cats offers. So the users of your library can choose Scalaz or Cats to be used with your library.
 
-A small Functional Programming library. This is not meant to be an alternative to Scalaz or Cats. The reason for having this library is that in your project you don't want to have Scalaz or Cats as its dependency and you only need much smaller set of functional programming features than what Scalaz or Cats offers. So the users of your library can choose Scalaz or Cats to be used with your library.
+## Getting Started
+In `build.sbt`,
 
-Please check out the [documentation](docs).
+```scala
+libraryDependencies += "io.kevinlee" %% "just-fp" % "1.3.5"
+```
+then import
+
+```scala
+import just.fp._
+import just.fp.syntax._
+```
+or 
+```scala
+import just.fp._, syntax._
+```
+In all the example code using `just-fp` below, I assume that you've already imported `just-fp` at the top.
 
diff --git a/docs/microsite/data/menu.yml b/docs/microsite/data/menu.yml
diff --git a/docs/docs/docs/syntax/either.md → docs/syntax/either.md b/docs/docs/docs/syntax/either.md → docs/syntax/either.md
@@ -1,9 +1,9 @@
 ---
-layout: docs
+id: 'either'
 title: "Either"
 ---
 
-# Either
+## Either
 
 ## Right-Biased `Either`
 `Either` in Scala prior to 2.12 is not right-biased meaning that you have to call `Either.right` all the time if you want to use it with `for-comprehension`.

diff --git a/docs/docs/docs/syntax/option.md → docs/syntax/option.md b/docs/docs/docs/syntax/option.md → docs/syntax/option.md
@@ -1,9 +1,9 @@
 ---
-layout: docs
+id: 'option'
 title: "Option"
 ---
 
-# Option
+## Option
 ## Option Constructors
 Similar to `Either`, creating `Option` can expose its data instead of type.
 

diff --git a/docs/docs/docs/syntax/index.md → docs/syntax/syntax.md b/docs/docs/docs/syntax/index.md → docs/syntax/syntax.md
@@ -1,5 +1,5 @@
 ---
-layout: docs
+id: 'syntax'
 title: "Syntax"
 ---
 # Syntax

diff --git a/docs/docs/docs/syntax/type-safe-equal.md → docs/syntax/type-safe-equal.md b/docs/docs/docs/syntax/type-safe-equal.md → docs/syntax/type-safe-equal.md
@@ -1,9 +1,9 @@
 ---
-layout: docs
+id: 'type-safe-equal'
 title: "Type-safe Equal"
 ---
 
-# Type-safe Equal
+## Type-safe Equal
 `==` in Scala is not type safe so the following code can never be `true` as their types are different but it has no compile-time error.
 
 ```scala

diff --git a/docs/typeclass/applicative.md b/docs/typeclass/applicative.md
@@ -0,0 +1,5 @@
+---
+layout: 'applicative'
+title: "Applicative"
+---
+## Applicative
diff --git a/docs/typeclass/either-t.md b/docs/typeclass/either-t.md
@@ -0,0 +1,5 @@
+---
+id: 'either-t'
+title: "EitherT"
+---
+## EitherT
diff --git a/docs/docs/docs/typeclass/functor.md → docs/typeclass/functor.md b/docs/docs/docs/typeclass/functor.md → docs/typeclass/functor.md
@@ -1,8 +1,8 @@
 ---
-layout: docs
+id: 'functor'
 title: "Functor"
 ---
-# Functor
+## Functor
 A `functor` is a typeclass for the types that can be mapped over.
 
 `Functor` complies with identity law and composition law.
@@ -31,13 +31,20 @@ import just.fp.syntax._
 val f = (a: Int) => a + 100
 val g = (b: Int) => b * 2
 
-Functor[Option].map(1.some)(f compose g) === Functor[Option].map(Functor[Option].map(1.some)(g))(f)
 Functor[Option].map(1.some)(f compose g)
+
 Functor[Option].map(Functor[Option].map(1.some)(g))(f)
 
-Functor[Option].map(none[Int])(f compose g) === Functor[Option].map(Functor[Option].map(none[Int])(g))(f)
+Functor[Option].map(1.some)(f compose g) ===
+  Functor[Option].map(Functor[Option].map(1.some)(g))(f)
+
+
 Functor[Option].map(none[Int])(f compose g)
+
 Functor[Option].map(Functor[Option].map(none[Int])(g))(f)
+
+Functor[Option].map(none[Int])(f compose g) ===
+  Functor[Option].map(Functor[Option].map(none[Int])(g))(f)
 ```
 
 

diff --git a/docs/docs/docs/typeclass/monad.md → docs/typeclass/monad.md b/docs/docs/docs/typeclass/monad.md → docs/typeclass/monad.md
@@ -1,5 +1,5 @@
 ---
-layout: docs
+id: 'monad'
 title: "Monad"
 ---
 # Monad
diff --git a/docs/docs/docs/typeclass/monoid.md → docs/typeclass/monoid.md b/docs/docs/docs/typeclass/monoid.md → docs/typeclass/monoid.md
@@ -1,5 +1,5 @@
 ---
-layout: docs
+id: 'monoid'
 title: "Monoid"
 ---
 # Monoid

diff --git a/docs/docs/docs/typeclass/semi-group.md → docs/typeclass/semi-group.md b/docs/docs/docs/typeclass/semi-group.md → docs/typeclass/semi-group.md
@@ -1,5 +1,5 @@
 ---
-layout: docs
+id: 'semi-group'
 title: "Semi-Group"
 ---
 

diff --git a/docs/docs/docs/typeclass/index.md → docs/typeclass/typeclass.md b/docs/docs/docs/typeclass/index.md → docs/typeclass/typeclass.md
@@ -1,8 +1,8 @@
 ---
-layout: docs
+id: 'typeclass'
 title: "Typeclass"
 ---
-# Typeclass
+## Typeclass
 
 * [Semi-Group](semi-group)
 * [Monoid](monoid)

diff --git a/docs/docs/docs/typeclass/writer-t.md → docs/typeclass/writer-t.md b/docs/docs/docs/typeclass/writer-t.md → docs/typeclass/writer-t.md
@@ -1,5 +1,5 @@
 ---
-layout: docs
+id: 'writer-t'
 title: "WriterT"
 ---
 # WriterT
diff --git a/website/.gitignore b/website/.gitignore
@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
diff --git a/website/babel.config.js b/website/babel.config.js
@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};
diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
@@ -0,0 +1,88 @@
+module.exports = {
+  title: 'Just FP',
+  tagline: 'Just a small Functional Programming library',
+  url: 'https://just-fp.kevinly.dev',
+  baseUrl: '/',
+  favicon: 'img/favicon.png',
+  organizationName: 'Kevin-Lee',
+  projectName: 'just-fp',
+  themeConfig: {
+    sidebarCollapsible: false,
+    prism: {
+      theme: require('prism-react-renderer/themes/nightOwl'),
+      darkTheme: require('prism-react-renderer/themes/nightOwl'),
+      additionalLanguages: ['scala'],
+    },
+    navbar: {
+      title: 'Just FP',
+      logo: {
+        alt: 'Just FP Logo',
+        src: 'img/just-fp-logo-32x32.png',
+      },
+      links: [
+        {
+          to: 'docs/',
+          activeBasePath: 'docs',
+          label: 'Docs',
+          position: 'left',
+        },
+        {
+          href: 'https://github.com/Kevin-Lee/just-fp',
+          label: 'GitHub',
+          position: 'right',
+        },
+      ],
+    },
+    footer: {
+      style: 'dark',
+      links: [
+        {
+          title: 'Docs',
+          items: [
+            {
+              label: 'Getting Started',
+              to: 'docs/',
+            },
+          ],
+        },
+        {
+          title: 'More',
+          items: [
+            {
+              label: 'GitHub',
+              href: 'https://github.com/Kevin-Lee/just-fp',
+            },
+            {
+              label: 'Blog',
+              href: 'https://blog.kevinlee.io',
+            },
+            {
+              label: 'Homepage',
+              href: 'https://kevinlee.io',
+            },
+          ],
+        },
+      ],
+      copyright: `Copyright © ${new Date().getFullYear()} just-fp, <a href="https://github.com/Kevin-Lee" target="_blank">Kevin Lee</a>. Built with Docusaurus.`,
+    },
+  },
+  presets: [
+    [
+      '@docusaurus/preset-classic',
+      {
+        docs: {
+          path: '../generated-docs/target/mdoc/',
+          // It is recommended to set document id as docs home page (`docs/` path).
+          homePageId: 'getting-started',
+          sidebarPath: require.resolve('./sidebars.js'),
+        },
+        blog: {
+          showReadingTime: true,
+        },
+        theme: {
+          customCss: require.resolve('./src/css/custom.css'),
+        },
+      },
+    ],
+  ],
+};