iinit

gatsby-config.js

@@ -8,7 +8,7 @@ module.exports = {
     siteAuthor: `@rocketseat`,
     siteImage: `/banner.png`,
     siteLanguage: `en`,
-    themeColor: `#7159c1`,
+    themeColor: `#e1a809`,
     basePath: `/`,
     footer: `Theme by Rocketseat`,
   },

src/@rocketseat/gatsby-theme-docs/.../theme.js

+export default {
+  colors: {
+    primary: '#E1A809',
+    background: '#fff',
+    sidebar: {
+      background: '#ffffff',
+      link: '#999',
+      heading: '#aaa',
+      linkActive: '#13131A',
+      itemActive: '#F5F5FA',
+      footer: '#A8A8B3',
+    },
+  },
+};

src/@rocketseat/gatsby-theme-docs/components/Logo.js

+import styled from '@emotion/styled';
+
+import logo from '../../../docs/anl_eic_logo_3.png';
+
+export default styled.div`
+  width: 260px;
+  height: 90px;
+  background-size: contain;
+  background: url(${logo}) center no-repeat;
+`;

src/@rocketseat/gatsby-theme-docs/styles/global.js

+import React from 'react';
+import { Global, css } from '@emotion/core';
+import { useTheme } from 'emotion-theming';
+import { lighten } from 'polished';
+
+export default function GlobalStyle() {
+  const theme = useTheme();
+
+  return (
+    <Global
+      styles={css`
+        @import url('https://fonts.googleapis.com/css?family=Roboto&display=swap');
+        @import url('https://fonts.googleapis.com/css?family=Roboto:300,400,500,700&display=swap');
+        @import url('https://fonts.googleapis.com/css?family=Poppins:300,400,500,600&display=swap');
+        *,
+        *::after,
+        *::before {
+          margin: 0;
+          padding: 0;
+          box-sizing: border-box;
+        }
+
+        *::selection {
+          background: ${lighten('0.35', '#737380')}!important;
+        }
+
+        body {
+          font-size: 16px;
+          font-family: 'Roboto', sans-serif;
+          background-color: ${theme.colors.background};
+          text-rendering: optimizelegibility;
+        }
+
+        h1 {
+          font-size: 32px;
+          color: #333;
+          font-weight: normal;
+          margin-bottom: 24px;
+        }
+
+        h2 {
+          font-size: 24px;
+          padding-bottom: 8px;
+          border-bottom: 1px solid #eee;
+        }
+
+        h3 {
+          font-size: 18px;
+        }
+
+        h4 {
+          font-size: 16px;
+        }
+
+        h2,
+        h3,
+        h4,
+        h5,
+        h6 {
+          color: #737380;
+          margin: 24px 0 16px 0;
+          font-weight: normal;
+        }
+
+        p {
+          color: #737380;
+          font-size: 16px;
+          line-height: 28px;
+          margin-bottom: 16px;
+          font-weight: 400;
+        }
+
+        code.inline-code {
+          display: inline-block;
+          vertical-align: middle;
+          line-height: 1;
+          padding: 0.2em 0.2em 0.3em 0.2em;
+          background-color: #44475a;
+          color: rgba(248, 248, 242);
+          font-size: 14px;
+          border-radius: 3px;
+          font-feature-settings: 'clig' 0, 'calt' 0;
+          font-variant: no-common-ligatures no-discretionary-ligatures
+            no-historical-ligatures no-contextual;
+        }
+
+        a {
+          color: #737380;
+          font-weight: bold;
+
+          &:hover {
+            color: ${theme.colors.primary}!important;
+            transition: all 100ms cubic-bezier(0.4, 0, 0.2, 1) 0s;
+            opacity: 1 !important;
+          }
+        }
+
+        blockquote {
+          border-left: 4px solid #e7e7e7;
+          padding: 0 2rem;
+
+          p {
+            font-style: italic !important;
+            font-size: 0.88em !important;
+            line-height: 28px;
+          }
+        }
+
+        table {
+          border-collapse: collapse;
+          border-spacing: 0;
+          width: 100%;
+          margin-bottom: 16px;
+          color: #444;
+        }
+
+        th,
+        td {
+          text-align: left;
+          padding: 12px;
+        }
+
+        tr:nth-of-type(2n) td {
+          background-color: ${theme.colors.sidebar.itemActive};
+        }
+
+        tr {
+          background-color: #ffffff;
+        }
+
+        iframe {
+          margin-bottom: 16px;
+        }
+
+        ul,
+        ol {
+          color: #737380;
+          padding-left: 15px;
+          margin-bottom: 16px;
+
+          li {
+            line-height: 28px;
+          }
+        }
+
+        .gatsby-highlight {
+          position: relative;
+
+          .token {
+            font-style: normal !important;
+          }
+        }
+
+        pre[class*='language-']::before {
+          background: #d9d7e0;
+          border-radius: 0 0 4px 4px;
+          color: #232129;
+          font-size: 12px;
+          font-family: SFMono-Regular, Menlo, Monaco, Consolas,
+            'Liberation Mono', 'Courier New', monospace;
+          letter-spacing: 0.075em;
+          line-height: 1;
+          padding: 0.25rem 0.5rem;
+          position: absolute;
+          left: 1rem;
+          text-align: right;
+          text-transform: uppercase;
+          top: 0;
+        }
+
+        pre[class*='language-'] code {
+          font-family: SFMono-Regular, Menlo, Monaco, Consolas,
+            'Liberation Mono', 'Courier New', monospace;
+          font-variant: no-common-ligatures no-discretionary-ligatures
+            no-historical-ligatures no-contextual;
+        }
+
+        pre[class~='language-js']::before,
+        pre[class~='language-javascript']::before {
+          content: 'js';
+          background: #f7df1e;
+        }
+
+        pre[class~='language-jsx']::before {
+          content: 'jsx';
+          background: #61dafb;
+        }
+
+        pre[class~='language-typescript']::before,
+        pre[class~='language-ts']::before {
+          content: 'ts';
+          background: #294e80;
+          color: #fff;
+        }
+
+        pre[class~='language-tsx']::before {
+          content: 'tsx';
+          background: #294e80;
+          color: #fff;
+        }
+
+        pre[class~='language-graphql']::before {
+          content: 'GraphQL';
+          background: #e10098;
+          color: #fff;
+        }
+
+        pre[class~='language-html']::before {
+          content: 'html';
+          background: #005a9c;
+          color: #fff;
+        }
+
+        pre[class~='language-css']::before {
+          content: 'css';
+          background: #ff9800;
+          color: #fff;
+        }
+
+        pre[class~='language-mdx']::before {
+          content: 'mdx';
+          background: #f9ac00;
+          color: #fff;
+        }
+
+        pre[class~='language-shell']::before {
+          content: 'shell';
+        }
+
+        pre[class~='language-sh']::before {
+          content: 'sh';
+        }
+
+        pre[class~='language-bash']::before {
+          content: 'bash';
+        }
+
+        pre[class~='language-yaml']::before {
+          content: 'yaml';
+          background: #ffa8df;
+        }
+
+        pre[class~='language-markdown']::before {
+          content: 'md';
+        }
+
+        pre[class~='language-json']::before,
+        pre[class~='language-json5']::before {
+          content: 'json';
+          background: linen;
+        }
+
+        pre[class~='language-diff']::before {
+          content: 'diff';
+          background: #e6ffed;
+        }
+
+        pre[class~='language-text']::before {
+          content: 'text';
+          background: #fff;
+        }
+
+        pre[class~='language-flow']::before {
+          content: 'flow';
+          background: #e8bd36;
+        }
+      `}
+    />
+  );
+}

src/@rocketseat/gatsby-theme-docs/styles/theme.js

+export default {
+  colors: {
+    primary: '#E1A809',
+    background: '#fff',
+    sidebar: {
+      background: '#ffffff',
+      link: '#999',
+      heading: '#aaa',
+      linkActive: '#13131A',
+      itemActive: '#F5F5FA',
+      footer: '#A8A8B3',
+    },
+  },
+};

src/config/sidebar.yml

 # Sidebar navigation
 
-- label: 'Introduction'
+- label: 'Home'
   link: '/'
-- label: 'Getting started'
-  link: '/getting-started'
+- label: 'Introduction'
+  link: '/introduction'
+- label: 'Getting really started'
+  items:
+    - label: 'Quick-start '
+      link: '/getting-started/quickstart'
+    - label: 'Modulefiles '
+      link: '/getting-started/modulefiles'
+    - label: 'Singularity'
+      link: '/getting-started/singularity'
+    - label: 'EIC container'
+      link: '/getting-started/eic_container'
+    - label: 'Environment'
+      link: '/getting-started/environment'
+- label: 'Part 1'
+  items:
 - label: Usage
   items:
+    - label: 'doc Getting started'
+      link: '/gettingstartedold'
     - label: 'Creating docs'
       link: '/usage/creating-docs'
     - label: 'Navigation'

src/docs/codeblock.md

+---
+title: "Syntax Highlighting"
+metaTitle: "Syntax Highlighting is the meta title tag for this page"
+metaDescription: "This is the meta description for this page"
+---
+
+The following is a code block with JavaScript language syntax highlighting.
+
+```javascript
+import React from 'react';
+```
+
+Supports multiple languages.
+
+The following is a code block with diff. Lines with `+` highlighted in green shade indicating an addition. Lines with `-` highlighted in red shade indicating a deletion.
+
+```javascript
+- const data = ['1','2'];
++ const data = [1,2];
+```
+
+## Live Editing example
+
+```javascript react-live=true
+<button className={'btn btn-default'}>Change my text</button>
+```

src/docs/codeblock/1-index.md

+---
+title: "Sub Page"
+metaTitle: "Syntax Highlighting is the meta title tag for this page"
+metaDescription: "This is the meta description for this page"
+---
+
+The following is a code block with JavaScript language syntax highlighting.
+
+```cpp
+int x = 5;
+```
+
+Supports multiple languages.
+
+The following is a code block with diff. Lines with `+` highlighted in green shade indicating an addition. Lines with `-` highlighted in red shade indicating a deletion.
+
+```javascript
+- const data = ['1','2'];
++ const data = [1,2];
+```
+
+## Live Editing example
+
+```javascript react-live=true
+<button className={'btn btn-default'}>Change my text</button>
+```

src/docs/codeblock/1-index/1-index.md

+---
+title: "derp"
+metaTitle: "meta derp title"
+metaDescription: "This is the meta description"
+---
+
+DERPDERP
+Some introduction text. Lists out all the headings from h1 to h6. Easy to customise.
+
+# Heading H1
+Heading 1 text
+
+## Heading H2
+Heading 2 text
+
+### Heading H3
+Heading 3 text
+
+#### Heading H4
+Heading 4 text
+
+##### Heading H5
+Heading 5 text
+
+###### Heading H6
+Heading 6 text
+
+## Lists
+- Item 1
+- Item 2
+- Item 3
+- Item 4
+- Item 5

src/docs/getting-started/eic_container.md

+---
+title: "EIC Container"
+---
+
+
+## Downloading the container.
+```shell
+git clone ...
+```
+
+## Installing the container
+
+```shell
+mkdir build 
+cmake ../. -DCMAKE_INSTALL_PREFIX=$HOME/stow/eic_container_1.0.0
+make -j4 install
+```
+

src/docs/getting-started/environment.md

+---
+title: "Development Environment"
+---
+
+## Development within singularity 
+
+The following helper runs bash inside `eic_container`
+```bash
+module load eic_container
+container_dev
+```
+
+For projects that you want to build but which are also inside of the container, you must make sure to set `$PATH` and `$LD_LIBRARY_PATH` to point to the development build's installation prefix first. Here we assume your development builds are being installed into `$HOME/stow/development`
+
+A simple setup script will make sure
+```bash
+export $PATH=$HOME/stow/development/bin:$PATH
+export $LD_LIBRARY_PATH=$HOME/stow/development/lib:$HOME/stow/development/lib64:$LD_LIBRARY_PATH
+export $ROOT_INCLUDE_PATH=$HOME/stow/development/include:$ROOT_INCLUDE_PATH
+```
+
+
+
+

src/docs/getting-started/modulefiles.md

+---
+title: "Modulefiles"
+---
+
+## What are modulefiles?
+
+Modulefiles (or Lmod) is installed on almost every HPC system these days. It is a set of tcl/tk or lua scripts to swap software in and out of your current environment. It does this (mostly) by managing your environment variables, namely, `PATH` and `LD_LIBRARY_PATH`.
+
+```bash
+module avail
+module list
+module load eic_container
+module list
+module purge 
+module list
+```
+
+
+https://modules.readthedocs.io/en/latest/
+
+
+
+
+

src/docs/getting-started/quickstart.md

+---
+title: "Quick start"
+metaTitle: "Quickstart"
+metaDescription: "Getting up and running quickly"
+---
+
+
+# Prerequisites
+
+The programmer should already be familiar with
+- working in the terminal over ssh
+- git and gitlab
+- using `cmake`
+- C++, python, and shell scripting
+
+[modulefiles](quickstart/1-modulefiles)
+[singularity](quickstart/2-singularity)
+[eic_container](quickstart/3-eic_container)
+
+# Clone Tutorial Repository
+
+# Environment
+
+
+

src/docs/getting-started/singularity.md

+---
+title: "Singularity"
+---
+
+Singularity is installed on `eic0.phy.anl.gov`, `bebop.lcrc.anl.gov`, and most HPC systems.
+Singularity ships the entire container image in a single file.  See the extensive singularity documentation to learn more. 
+```bash
+git clone git@eicweb.phy.anl.gov/containers/eic_container.git
+cd container 
+```
+
+## Installing the singularity container
+
+## Using the container
+
+## Tip 
+
+In your `.bashrc` add 
+```bash
+if [ ! -e /environment ] ; then
+  running_singularity=
+else
+  running_singularity="\#singularity"
+fi
+# ...
+PS1='${debian_chroot:+($debian_chroot)}\[\033[01;32m\]\u@\h\[\033[00m\]:\[\033[01;34m\]\w\[\033[00m\]${running_singularity}\$ '
+```
+If you are running inside a singularity container your commandline prompt will inform you:
+
+<pre><font color="#8AE234"><b>whit@wpad</b></font>:<font color="#729FCF"><b>~/stow/eic_container_0.9.13/lib</b></font>\#singularity$</pre>
+

src/docs/hackathon.md

+---
+title: "Simulation Hackathon "
+---
+
+# Goals
+
+

src/docs/hackathon/1-tasks.md

+---
+title: "Hackathon tasks "
+metaTitle: "hackathon"
+metaDescription: "EIC software hackathon"
+---
+
+# Goals

src/docs/index.mdx

+---
+title: "EIC Software"
+---
+
+## Tutorials
+
+- [Quick start](quickstart.md) - Start here to download software and configure your development environment.
+
+- [Part 1](part1.md) - An introduction to the detector description starting with a simple detector. 
+This tutorial shows how to add new parameterized detectors to a library of generic detectors (NPdet).
+
+- [Part 2](part2.md) - 
+
+This tutorial is broken in to multiple parts.
+
+* Preface for the new programmer
+* Part 0a: Configuring your running environment
+* Part 0b: Configuring your development environment
+* Part 1: Simple Detector Example
+* Part 2: Extending Detector Geometry
+* Part 3: Adding a new detector
+* Part 4: Detector digitization, volumes, and segmentation 
+* Part 5: Event reconstruction
+
+
+Some introduction text. Lists out all the headings from h1 to h6. Easy to customise. Some more text. Additional text.
+
+# Heading H1
+Heading 1 text
+
+## Heading H2
+Heading 2 text
+
+### Heading H3
+Heading 3 text
+
+#### Heading H4
+Heading 4 text
+
+##### Heading H5
+Heading 5 text
+
+###### Heading H6
+Heading 6 text
+

src/docs/introduction.mdx

+---
+title: "Introduction"
+metaTitle: "This is the title tag of this page"
+metaDescription: "This is the meta description"
+---
+
+# Tutorial
+
+- [Quick start](quickstart.md)
+Start here to setup download software and configure your development environment.
+- [Part 1](part1.md)
+An introduction to detecto description starting with a simple detector. This tutorial shows how to add new parameterized detectors to a library of generic detectors (NPdet).
+- [Part 2](part2.md) 
+
+This tutorial is broken in to multiple parts.
+
+* Preface for the new programmer
+* Part 0a: Configuring your running environment
+* Part 0b: Configuring your development environment
+* Part 1: Simple Detector Example
+* Part 2: Extending Detector Geometry
+* Part 3: Adding a new detector
+* Part 4: Detector digitization, volumes, and segmentation 
+* Part 5: Event reconstruction
+
+
+Some introduction text. Lists out all the headings from h1 to h6. Easy to customise. Some more text. Additional text.
+
+# Heading H1
+Heading 1 text
+
+## Heading H2
+Heading 2 text
+
+### Heading H3
+Heading 3 text
+
+#### Heading H4
+Heading 4 text
+
+##### Heading H5
+Heading 5 text
+
+###### Heading H6
+Heading 6 text
+
+
+
+# Welcome
+This tutorial is meant to prepare you to contribute to the simuliation toolkit for the EIC.
+The tutorial is not meant to be a representation of the final software workflow, but to put enough pieces
+together to do the work required.  
+
+
+## Lists
+- Item 1
+- Item 2
+- Item 3
+- Item 4
+- Item 5