1.8.3 • Published 10 months ago

@lpgroup/docs v1.8.3

Weekly downloads
-
License
MIT
Repository
gitlab
Last release
10 months ago

@lpgroup/docs

MDX parser library that returns a styled JSX.

Contents

Getting Started

The objective of this library is to parse MDX files and convert them into a ready-made 'documentation format'.

yarn create vite

Installation

To install this library, we can run in the command line.

# via yarn
yarn add @lpgroup/docs

# via npm
npm install --save @lpgroup/docs

MDX Setup

import React from "react";
import LPDocs, { DocsSkeleton } from "@lpgroup/docs";
import { SampleLogo, Footer } from "./custom/SampleLogo";
const systemFont = `Raleway, Lato, -apple-system, BlinkMacSystemFont, "Segoe UI", "Roboto", sans-serif`;

const typhographySettings = {
  h1: {
    fontSize: "2.2rem",
    fontWeight: 600,
    fontFamily: systemFont,
    color: "#3cf",
  },
  h2: {
    fontSize: "1.5rem",
    fontWeight: 500,
    fontFamily: systemFont,
  },

  h3: {
    fontSize: "1.3rem",
    fontWeight: 500,
    fontFamily: systemFont,
  },
  h4: {
    fontSize: "1rem",
    fontWeight: 500,
  },
  body1: {
    lineHeight: 1.7,
    fontFamily: systemFont,
  },
  body2: {
    "fontSize": 15,
    "fontFamily": systemFont,
    "&:hover": {
      color: "#6969ff",
    },
  },
};

const Pages = React.lazy(() => import("./pages/v1"));

function App() {
  return (
    <LPDocs
      Logo={SampleLogo}
      Footer={Footer}
      sideBarHeight={60}
      isAuth={true}
      font={systemFont}
      textAlign={"justify"}
      typhography={typhographySettings}
    >
      <React.Suspense fallback={<DocsSkeleton />}>
        <Pages />
      </React.Suspense>
    </LPDocs>
  );
}

export default App;

Contribute

See contribute

License

MIT - See licence

mdx
@emotion/react@emotion/styled@lpgroup/vite-plugin-replace@mdx-js/loader@mdx-js/react@mdx-js/rollup@mui/icons-material@mui/materialreactreact-domreact-isreact-syntax-highlighterrollupwebpack
@everything-registry/sub-chunk-560
1.8.2

10 months ago

1.8.1

10 months ago

1.8.3

10 months ago

1.8.0

10 months ago

1.7.3

10 months ago

1.7.2

11 months ago

1.6.0

11 months ago

1.5.9

12 months ago

1.5.8

12 months ago

1.5.7

12 months ago

1.5.5

12 months ago

1.5.4

12 months ago

1.5.6

12 months ago

1.5.1

1 year ago

1.5.0

1 year ago

1.4.6

1 year ago

1.4.5

1 year ago

1.4.1

1 year ago

1.4.0

1 year ago

1.3.182

1 year ago

1.3.183

1 year ago

1.3.181

1 year ago

1.3.180

1 year ago

1.3.179

1 year ago

1.3.178

2 years ago

1.3.174

2 years ago

1.3.177

2 years ago

1.3.176

2 years ago

1.3.175

2 years ago

1.3.171

2 years ago

1.3.170

2 years ago

1.3.173

2 years ago

1.3.149

2 years ago

1.3.148

2 years ago

1.3.147

2 years ago

1.3.157

2 years ago

1.3.156

2 years ago

1.3.155

2 years ago

1.3.154

2 years ago

1.3.158

2 years ago

1.3.153

2 years ago

1.3.152

2 years ago

1.3.151

2 years ago

1.3.169

2 years ago

1.3.160

2 years ago

1.3.163

2 years ago

1.3.162

2 years ago

1.3.135

2 years ago

1.3.133

2 years ago

1.3.139

2 years ago

1.3.138

2 years ago

1.3.136

2 years ago

1.3.145

2 years ago

1.3.144

2 years ago

1.3.143

2 years ago

1.3.142

2 years ago

1.3.141

2 years ago

1.3.140

2 years ago

1.3.119

2 years ago

1.3.124

2 years ago

1.3.123

2 years ago

1.3.122

2 years ago

1.3.121

2 years ago

1.3.127

2 years ago

1.3.126

2 years ago

1.3.125

2 years ago

1.3.120

2 years ago

1.3.129

2 years ago

1.3.132

2 years ago

1.3.131

2 years ago

1.3.130

2 years ago

1.3.118

3 years ago

1.3.106

3 years ago

1.3.109

3 years ago

1.3.107

3 years ago

1.3.113

3 years ago

1.3.112

3 years ago

1.3.111

3 years ago

1.3.110

3 years ago

1.3.117

3 years ago

1.3.116

3 years ago

1.3.115

3 years ago

1.3.114

3 years ago

1.3.105

3 years ago

1.3.104

3 years ago

1.3.90

3 years ago

1.3.93

3 years ago

1.3.94

3 years ago

1.3.91

3 years ago

1.3.92

3 years ago

1.3.97

3 years ago

1.3.98

3 years ago

1.3.95

3 years ago

1.3.96

3 years ago

1.3.99

3 years ago

1.3.102

3 years ago

1.3.101

3 years ago

1.3.100

3 years ago

1.3.103

3 years ago

1.3.75

3 years ago

1.3.76

3 years ago

1.3.79

3 years ago

1.3.77

3 years ago

1.3.78

3 years ago

1.3.82

3 years ago

1.3.83

3 years ago

1.3.80

3 years ago

1.3.81

3 years ago

1.3.86

3 years ago

1.3.87

3 years ago

1.3.84

3 years ago

1.3.85

3 years ago

1.3.89

3 years ago

1.3.65

3 years ago

1.3.68

3 years ago

1.3.69

3 years ago

1.3.66

3 years ago

1.3.67

3 years ago

1.3.71

3 years ago

1.3.72

3 years ago

1.3.70

3 years ago

1.3.73

3 years ago

1.3.74

3 years ago

1.3.50

3 years ago

1.3.53

3 years ago

1.3.54

3 years ago

1.3.52

3 years ago

1.3.57

3 years ago

1.3.58

3 years ago

1.3.55

3 years ago

1.3.56

3 years ago

1.3.59

3 years ago

1.3.60

3 years ago

1.3.61

3 years ago

1.3.64

3 years ago

1.3.62

3 years ago

1.3.63

3 years ago

1.3.46

3 years ago

1.3.45

3 years ago

1.3.39

4 years ago

1.3.42

4 years ago

1.3.43

4 years ago

1.3.40

4 years ago

1.3.41

4 years ago

1.3.36

4 years ago

1.3.34

4 years ago

1.3.37

4 years ago

1.3.38

4 years ago

1.3.31

4 years ago

1.3.32

4 years ago

1.3.33

4 years ago

1.3.30

4 years ago

1.3.29

4 years ago

1.3.28

4 years ago

1.3.27

4 years ago

1.3.26

4 years ago

1.3.25

4 years ago

1.3.23

4 years ago

1.3.21

4 years ago

1.3.22

4 years ago

1.3.20

4 years ago

1.3.18

4 years ago

1.3.17

4 years ago

1.3.16

4 years ago

1.3.15

4 years ago