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

docs(manuals): extensive rewrite #11825

Merged
merged 3 commits into from Jan 14, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/css/style.css
Expand Up @@ -38,6 +38,10 @@ div.sequelize {
font-size: 17px;
}

.no-mouse {
pointer-events: none;
}

.api-reference-link {
font-weight: bold;
padding: 0 20px;
Expand Down
18 changes: 9 additions & 9 deletions docs/index.md
Expand Up @@ -18,11 +18,11 @@
[![License](https://badgen.net/github/license/sequelize/sequelize)](https://github.com/sequelize/sequelize/blob/master/LICENSE)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

Sequelize is a promise-based Node.js ORM for Postgres, MySQL, MariaDB, SQLite and Microsoft SQL Server. It features solid transaction support, relations, eager and lazy loading, read replication and more.
Sequelize is a promise-based Node.js [ORM](https://en.wikipedia.org/wiki/Object-relational_mapping) for [Postgres](https://en.wikipedia.org/wiki/PostgreSQL), [MySQL](https://en.wikipedia.org/wiki/MySQL), [MariaDB](https://en.wikipedia.org/wiki/MariaDB), [SQLite](https://en.wikipedia.org/wiki/SQLite) and [Microsoft SQL Server](https://en.wikipedia.org/wiki/Microsoft_SQL_Server). It features solid transaction support, relations, eager and lazy loading, read replication and more.

Sequelize follows [SEMVER](http://semver.org). Supports Node v10 and above to use ES6 features.
Sequelize follows [Semantic Versioning](http://semver.org) and supports Node v10 and above.

You are currently looking at the **Tutorials and Guides** for Sequelize. You might also be interested in the [API Reference](identifiers).
You are currently looking at the **Tutorials and Guides** for Sequelize. You might also be interested in the [API Reference](identifiers.html).

## Quick example

Expand All @@ -36,14 +36,14 @@ User.init({
birthday: DataTypes.DATE
}, { sequelize, modelName: 'user' });

sequelize.sync()
.then(() => User.create({
(async () => {
await sequelize.sync();
const jane = await User.create({
username: 'janedoe',
birthday: new Date(1980, 6, 20)
}))
.then(jane => {
console.log(jane.toJSON());
});
console.log(jane.toJSON());
})();
```

To learn more about how to use Sequelize, read the tutorials available in the left menu. Begin with [Getting Started](manual/getting-started).
To learn more about how to use Sequelize, read the tutorials available in the left menu. Begin with [Getting Started](manual/getting-started.html).
64 changes: 44 additions & 20 deletions docs/manual-groups.json
@@ -1,26 +1,50 @@
{
"Core Concepts": [
"getting-started.md",
"dialects.md",
"data-types.md",
"models-definition.md",
"models-usage.md",
"hooks.md",
"querying.md",
"instances.md",
"associations.md",
"raw-queries.md"
"core-concepts/getting-started.md",
"core-concepts/model-basics.md",
"core-concepts/model-instances.md",
"core-concepts/model-querying-basics.md",
"core-concepts/model-querying-finders.md",
"core-concepts/getters-setters-virtuals.md",
"core-concepts/validations-and-constraints.md",
"core-concepts/raw-queries.md",
"core-concepts/assocs.md",
"core-concepts/paranoid.md"
],
"Advanced Association Concepts": [
"advanced-association-concepts/eager-loading.md",
"advanced-association-concepts/creating-with-associations.md",
"advanced-association-concepts/advanced-many-to-many.md",
"advanced-association-concepts/association-scopes.md",
"advanced-association-concepts/polymorphic-associations.md"
],
"Other Topics": [
"transactions.md",
"scopes.md",
"read-replication.md",
"migrations.md",
"resources.md",
"typescript.md",
"upgrade-to-v6.md",
"legacy.md",
"whos-using.md",
"legal.md"
"other-topics/dialect-specific-things.md",
"other-topics/transactions.md",
"other-topics/hooks.md",
"other-topics/query-interface.md",
"other-topics/naming-strategies.md",
"other-topics/scopes.md",
"other-topics/sub-queries.md",
"other-topics/other-data-types.md",
"other-topics/constraints-and-circularities.md",
"other-topics/extending-data-types.md",
"other-topics/indexes.md",
"other-topics/optimistic-locking.md",
"other-topics/read-replication.md",
"other-topics/connection-pool.md",
"other-topics/legacy.md",
"other-topics/migrations.md",
"other-topics/typescript.md",
"other-topics/resources.md",
"other-topics/upgrade-to-v6.md",
"other-topics/whos-using.md",
"other-topics/legal.md"
],
"__hidden__": [
"moved/associations.md",
"moved/data-types.md",
"moved/models-usage.md",
"moved/querying.md"
]
}