Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation #2

Open
wants to merge 47 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
47 commits
Select commit Hold shift + click to select a range
363fd9f
added docusaurus and sass support
Dec 23, 2020
9e351ef
added appicons ios, android, web
Dec 23, 2020
0416a7a
rename icons
Dec 23, 2020
0dd6e56
updated docu config logos
Dec 23, 2020
d29dc65
darkmode logo
Dec 23, 2020
11e7101
ria data from gh. *Should pull from a CMS?
Dec 23, 2020
cb0ec24
added typescript support
Dec 23, 2020
c2fe5a5
, pwa workbox
Dec 23, 2020
20ad58c
correct yutedoc slugs
Dec 23, 2020
21e1aaa
init
Dec 23, 2020
b6de1d6
init
Dec 23, 2020
7a5d8f0
include build folder in docs branch
Dec 23, 2020
b8f12b5
edit readme
Dec 23, 2020
fd63878
GitHub actions. First build trigger
Dec 23, 2020
91d4d3a
create website directory.
Dec 23, 2020
33572ad
docusaur prefers the yarn
Dec 23, 2020
96cb9d6
rename folder
Dec 23, 2020
4e21860
build
Dec 23, 2020
96b0444
add
Dec 23, 2020
9be1b98
add site config to circumvent a docusaurus bug
Dec 23, 2020
ab1e962
changed structure.
Dec 23, 2020
9ea660f
changed structure for scientific reasons
Dec 23, 2020
f4ebf99
changed structure for scientific reasons
Dec 23, 2020
967e17b
changed structure for scientific reasons
Dec 23, 2020
cf21c37
mod ignore
Dec 23, 2020
73d0859
init build
Dec 23, 2020
7496f86
fix hero image
Dec 23, 2020
ff29d24
Have url mappings semi sophisticated.
Dec 23, 2020
25143b6
modified readme.
Dec 24, 2020
cec0432
nailed mapping of routes
Dec 24, 2020
52580af
added a new contributers action
Dec 24, 2020
0cb628d
mod yaml
Dec 24, 2020
33a84dd
Contributers.
Dec 24, 2020
da062e5
update yaml
Dec 24, 2020
e90a13e
for murica!
Dec 24, 2020
2945143
i win
Dec 24, 2020
55f85f2
right key
Dec 24, 2020
6a7d3cf
build
Dec 24, 2020
e307608
add to ignore
Dec 24, 2020
beefe0c
remove main.yml not using it.
Dec 24, 2020
dbfd19a
fixed documentaion.yaml
Dec 24, 2020
56605a6
added a PWA functionality with offline mode.
Dec 24, 2020
2700ea5
pwa
Dec 24, 2020
96a560e
modify git
Dec 24, 2020
0ee95b2
service worker is printing messages in console.
Dec 24, 2020
41247b5
removed some deps.
Dec 24, 2020
8e0f1e0
update manifest!
Dec 24, 2020
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
60 changes: 60 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @format
*/

const OFF = 0;
const WARNING = 1;
const ERROR = 2;

module.exports = {
root: true,
env: {
browser: true,
commonjs: true,
jest: true,
node: true,
},
parser: 'babel-eslint',
parserOptions: {
allowImportExportEverywhere: true,
},
extends: ['airbnb', 'prettier', 'prettier/react'],
plugins: ['react-hooks', 'header'],
rules: {
// Ignore certain webpack alias because it can't be resolved
'import/no-unresolved': [
ERROR,
{ignore: ['^@theme', '^@docusaurus', '^@generated']},
],
'import/extensions': OFF,
'header/header': [
ERROR,
'block',

[
'*',
' * Copyright (c) Facebook, Inc. and its affiliates.',
' *',
' * This source code is licensed under the MIT license found in the',
' * LICENSE file in the root directory of this source tree.',
' *',
// Unfortunately eslint-plugin-header doesn't support optional lines.
// If you want to enforce your website JS files to have @flow or @format,
// modify these lines accordingly.
{
pattern: '.* @format',
},
' ',
],
],
'react/jsx-closing-bracket-location': OFF, // Conflicts with Prettier.
'react/jsx-filename-extension': OFF,
'react-hooks/rules-of-hooks': ERROR,
'react/prop-types': OFF, // PropTypes aren't used much these days.
},
};
65 changes: 65 additions & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
name: documentation

on:
pull_request:
branches: [documentation]
push:
branches: [documentation]

jobs:

checks:
if: github.event_name != 'push'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- uses: actions/setup-node@v1
with:
node-version: '12.x'
- name: Test Build
run: |
if [ -e yarn.lock ]; then
yarn install --frozen-lockfile
elif [ -e package-lock.json ]; then
npm ci
else
npm i
fi
npm run build
gh-release:
if: github.event_name != 'pull_request'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- uses: actions/setup-node@v1
with:
node-version: '12.x'
- name: Add key to allow access to repository
env:
SSH_AUTH_SOCK: /tmp/ssh_agent.sock
run: |
mkdir -p ~/.ssh
ssh-keyscan github.com >> ~/.ssh/known_hosts
echo "${{ secrets.GH_PAGES_DEPLOY }}" > ~/.ssh/id_rsa
chmod 600 ~/.ssh/id_rsa
cat <<EOT >> ~/.ssh/config
Host github.com
HostName github.com
IdentityFile ~/.ssh/id_rsa
EOT

- name: Release to GitHub Pages
env:
USE_SSH: true
GIT_USER: git
run: |
git config --global user.email "[email protected]"
git config --global user.name "gh-actions"
if [ -e yarn.lock ]; then
yarn install --frozen-lockfile
elif [ -e package-lock.json ]; then
npm ci
else
npm i
fi
npx docusaurus deploy
25 changes: 25 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
node_modules
# Dependencies

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*

# ESLint
.eslintcache



3 changes: 3 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules
build
.docusaurus
9 changes: 9 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"arrowParens": "always",
"bracketSpacing": false,
"jsxBracketSameLine": true,
"printWidth": 80,
"proseWrap": "never",
"singleQuote": true,
"trailingComma": "all"
}
13 changes: 13 additions & 0 deletions .stylelintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

module.exports = {
plugins: ['stylelint-copyright'],
rules: {
'docusaurus/copyright-header': true,
},
};
12 changes: 12 additions & 0 deletions babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @format
*/

module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};
11 changes: 11 additions & 0 deletions blog/2020-12-23.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
slug: hello-universe
title: Hello World
author: Ria
author_title: The first post
author_url: https://github.com/riapacheco
author_image_url: https://avatars2.githubusercontent.com/u/53801436?s=460&u=24a361c7cb532e96ff36122fae9d593c73897066&v=4
tags: [hola, docusaurus]
---

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
82 changes: 82 additions & 0 deletions docs/features.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
id: features
title: Features
---

## Forms

```scss
@forward './scss/_user-controls/forms.scss';
```

### Example

```jsx live function Clock(props) {
const [date, setDate] = useState(new Date());
useEffect(() => {
var timerID = setInterval(() => tick(), 1000);

return function cleanup() {
clearInterval(timerID);
};
});

function tick() {
setDate(new Date());
}

return (
<div>
<h2>It is {date.toLocaleTimeString()}.</h2>
</div>
);
}
```

## Buttons

```scss
@forward './scss/_user-controls/buttons.scss';
```

## Colors

```scss
@import './scss/_foundation/colors.scss';
```

## Alternative Colors

```scss
@import './scss/_foundation/alt-colors.scss';
```

## Typography

```scss
@import './scss/_foundation/typography.scss';
```

## Themes

```scss
@import './scss/_foundation/themes.scss';
```

## Utilities

```scss
@import './scss/_foundation/utilities.scss';
```

## Cards

```scss
@import './scss/_component/cards.scss';
```

## Mixins

```scss
@import './scss/_component/feature-mixins.scss';
```
18 changes: 18 additions & 0 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
id: installation
title: Installation
---

## Install

#### Terminal:

````shell
npm install @riapacheco/yutes```


# In your main scss file:

```css
@import '~@riapacheco/yutes/yutes.scss';
````
Loading