1.5.1 • Published 2 days ago

@lpgroup/docs v1.5.1

Weekly downloads
-
License
MIT
Repository
gitlab
Last release
2 days 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

1.5.1

2 days ago

1.5.0

2 days ago

1.4.6

29 days ago

1.4.5

29 days ago

1.4.1

30 days ago

1.4.0

2 months ago

1.3.182

2 months ago

1.3.183

2 months ago

1.3.181

2 months ago

1.3.180

2 months ago

1.3.179

2 months ago

1.3.178

3 months ago

1.3.174

3 months ago

1.3.177

4 months ago

1.3.176

4 months ago

1.3.175

4 months ago

1.3.171

6 months ago

1.3.170

6 months ago

1.3.173

6 months ago

1.3.149

8 months ago

1.3.148

9 months ago

1.3.147

9 months ago

1.3.157

7 months ago

1.3.156

7 months ago

1.3.155

7 months ago

1.3.154

8 months ago

1.3.158

7 months ago

1.3.153

8 months ago

1.3.152

8 months ago

1.3.151

8 months ago

1.3.169

6 months ago

1.3.160

7 months ago

1.3.163

7 months ago

1.3.162

7 months ago

1.3.135

12 months ago

1.3.133

1 year ago

1.3.139

12 months ago

1.3.138

12 months ago

1.3.136

12 months ago

1.3.145

11 months ago

1.3.144

11 months ago

1.3.143

11 months ago

1.3.142

11 months ago

1.3.141

11 months ago

1.3.140

11 months ago

1.3.119

1 year ago

1.3.124

1 year ago

1.3.123

1 year ago

1.3.122

1 year ago

1.3.121

1 year ago

1.3.127

1 year ago

1.3.126

1 year ago

1.3.125

1 year ago

1.3.120

1 year ago

1.3.129

1 year ago

1.3.132

1 year ago

1.3.131

1 year ago

1.3.130

1 year ago

1.3.118

1 year ago

1.3.106

2 years ago

1.3.109

1 year ago

1.3.107

1 year ago

1.3.113

1 year ago

1.3.112

1 year ago

1.3.111

1 year ago

1.3.110

1 year ago

1.3.117

1 year ago

1.3.116

1 year ago

1.3.115

1 year ago

1.3.114

1 year ago

1.3.105

2 years ago

1.3.104

2 years ago

1.3.90

2 years ago

1.3.93

2 years ago

1.3.94

2 years ago

1.3.91

2 years ago

1.3.92

2 years ago

1.3.97

2 years ago

1.3.98

2 years ago

1.3.95

2 years ago

1.3.96

2 years ago

1.3.99

2 years ago

1.3.102

2 years ago

1.3.101

2 years ago

1.3.100

2 years ago

1.3.103

2 years ago

1.3.75

2 years ago

1.3.76

2 years ago

1.3.79

2 years ago

1.3.77

2 years ago

1.3.78

2 years ago

1.3.82

2 years ago

1.3.83

2 years ago

1.3.80

2 years ago

1.3.81

2 years ago

1.3.86

2 years ago

1.3.87

2 years ago

1.3.84

2 years ago

1.3.85

2 years ago

1.3.89

2 years ago

1.3.65

2 years ago

1.3.68

2 years ago

1.3.69

2 years ago

1.3.66

2 years ago

1.3.67

2 years ago

1.3.71

2 years ago

1.3.72

2 years ago

1.3.70

2 years ago

1.3.73

2 years ago

1.3.74

2 years ago

1.3.50

2 years ago

1.3.53

2 years ago

1.3.54

2 years ago

1.3.52

2 years ago

1.3.57

2 years ago

1.3.58

2 years ago

1.3.55

2 years ago

1.3.56

2 years ago

1.3.59

2 years ago

1.3.60

2 years ago

1.3.61

2 years ago

1.3.64

2 years ago

1.3.62

2 years ago

1.3.63

2 years ago

1.3.46

2 years ago

1.3.45

2 years ago

1.3.39

2 years ago

1.3.42

2 years ago

1.3.43

2 years ago

1.3.40

2 years ago

1.3.41

2 years ago

1.3.36

2 years ago

1.3.34

2 years ago

1.3.37

2 years ago

1.3.38

2 years ago

1.3.31

3 years ago

1.3.32

3 years ago

1.3.33

3 years ago

1.3.30

3 years ago

1.3.29

3 years ago

1.3.28

3 years ago

1.3.27

3 years ago

1.3.26

3 years ago

1.3.25

3 years ago

1.3.23

3 years ago

1.3.21

3 years ago

1.3.22

3 years ago

1.3.20

3 years ago

1.3.18

3 years ago

1.3.17

3 years ago

1.3.16

3 years ago

1.3.15

3 years ago